Merge branch 'master' of github.com:yarbshk/vue-formly-buefy

CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

@@ -0,0 +1,43 @@
+# Contributing
+You are here to help on **vue-formly-buefy**? Awesome, feel welcome and read the following sections to know what and how to work on something. 
+
+It's an open source project and we love to receive contributions from our community — you! There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests or writing code which can be incorporated into **vue-formly-buefy** itself.
+
+## Code of Conduct
+All members of our community are expected to follow our [Code of Conduct](https://github.com/yarbshk/vue-formly-buefy/blob/master/CODE_OF_CONDUCT.md). Please make sure you are welcoming and friendly in all of our spaces.
+
+## Issues
+Before you submit an issue, please **search the issue tracker**, maybe an issue for your problem already exists and the discussion might inform you of workarounds readily available.
+
+We want to fix all the issues as soon as possible, but before fixing a bug we need to reproduce and confirm it. In order to reproduce bugs we ask you to **provide a minimal reproduction scenario** that include:
+- Version of the plugin used.
+- Environment information (3rd-party libraries, technology stack etc.).
+- A use-case that fails.
+
+If you get stuck at any point you can create a [ticket on GitHub](https://github.com/yarbshk/vue-formly-buefy/issues).
+
+## Pull requests
+**Working on your first Pull Request?** You can learn how from this free series, [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github).
+
+If you would make PR for something that is bigger than a one or two line fix:
+1. Create your own fork of the code.
+2. **Before start development** be sure you are following:
+    - Our [Code of Conduct](https://github.com/yarbshk/vue-formly-buefy/blob/master/CODE_OF_CONDUCT.md).
+    - [The documented overview](https://github.com/yarbshk/vue-formly-buefy/wiki#overview) to have a particular roadmap.
+    - The code style for the project (use our `.eslint`).
+    - Commit message convention (sentence case, present time).
+3. Do the changes in your fork.
+4. **Write one or more specs** (unit-tests) for all features or bug fixes.
+5. Provide documentation for all public API methods.
+6. Only **if you like the change** and think **the project could use it**:
+    - Send a pull request.
+
+## Getting started
+To **run the project for development** use the following micro guide:
+1. Get local copy of the project.
+2. Be sure that [Docker](https://www.docker.com/), [Docker Compose](https://docs.docker.com/compose/) and Google Chrome (needs for test) installed.
+3. Kill a process which occupy the `9876` port (needs for test).
+4. Set the `yarn && yarn test` command for the `client` service in the `docker-compose.yml`.
+5. Open root directory of the project in the terminal and run the `docker-compose up` command.
+
+When work has done properly all npm packages will be install and Karma test server run on the `9876` port.

README.md

@@ -1,6 +1,6 @@
 # vue-formly-buefy
 Vue.js plugin that covers the [Buefy](https://buefy.github.io) form fields for [Formly](https://github.com/formly-js/vue-formly). Allows you to combine simplicity of Formly form builder, lightness of Buefy form components and impeccability of [Bulma](http://bulma.io/) design.
-- **Fully-featured.** All Buefy form components are covered (**Input**, **Select**, **Autocomplete**, **Checkbox**, **Radio** and **Switch**). Create form elements of all native input types + textarea.
+- **Fully-featured.** All Buefy form components are covered (**Input**, **Select**, **Autocomplete**, **Checkbox**, **Radio** and **Switch**). Create form elements of all native `input` types + `textarea`.
 - **Well-judged.** Wrapper elements now accessible (**Field**). Wrap Input, Select and Autocomplete form components to increase its functionality (`.controls` elements, validation state indicator, addons available).
 - **Straightforward.** Simple is better than complex.
 
@@ -50,38 +50,40 @@ Simple example of creating an input type with a static button (span):
 <script>
   export default {
     // Set initial values for Formly form
-    data: () => ({
-      form: {},
-      model: {
-        email: ''
-      },
-      fields: [
-        {
-          key: 'email',
-          type: 'input-with-field',         // Easy wrapping with a field wrapper
-          templateOptions: {
-            properties: {                   
-              'placeholder': 'Your email'   // It's recommended to use quotes and kebab-case
-            },
-            wrapper: {                      // Configuration object of the field wrapper
-              controls: {
-                after: [
-                  {                         // Use the Span helper as a field control
-                    type: this.$formlyBuefy.plainControls.Span,
-                    options: {              // Configuration object of the field control
-                      label: '@gmail.com',
-                      properties: {
-                        'class': 'button is-static'
+    data () {
+      return {
+        form: {},
+        model: {
+          email: ''
+        },
+        fields: [
+          {
+            key: 'email',
+            type: 'input-with-field',         // Easy wrapping with a field wrapper
+            templateOptions: {
+              properties: {                   
+                'placeholder': 'Your email'   // It's recommended to use quotes and kebab-case
+              },
+              wrapper: {                      // Configuration object of the field wrapper
+                controls: {
+                  after: [
+                    {                         // Use the Span helper as a field control
+                      type: this.$formlyBuefy.plainControls.Span,
+                      options: {              // Configuration object of the field control
+                        label: '@gmail.com',
+                        properties: {
+                          'class': 'button is-static'
+                        }
                       }
                     }
-                  }
-                ]
+                  ]
+                }
               }
             }
           }
-        }
-      ]
-    })
+        ]
+      }
+    }
   }
 </script>
 ```
@@ -104,8 +106,5 @@ The plugin passed the beta testing stage and now available for using in the **pr
 
 I'll probably add more functionality later. This is what I need right now.
 
-## Issues
-Be free to open an issue if you notice a bug. Let's make web a little bit better together :)
-
 ## Copyright and License
 Copyright (c) 2017 Yuriy Rabeshko. Code released under the MIT license.