|
1 | | -# Contributing Guidelines |
2 | | - |
3 | | -Contributions welcome! |
4 | | - |
5 | | -**Before spending lots of time on something, ask for feedback on your idea first!** |
6 | | - |
7 | | -Please search issues and pull requests before adding something new to avoid duplicating efforts and conversations. |
8 | | - |
9 | | -This project welcomes non-code contributions, too! The following types of contributions are welcome: |
10 | | - |
11 | | -- **Ideas**: participate in an issue thread or start your own to have your voice heard. |
12 | | -- **Writing**: contribute your expertise in an area by helping expand the included docs. |
13 | | -- **Copy editing**: fix typos, clarify language, and improve the quality of the docs. |
14 | | -- **Formatting**: help keep docs easy to read with consistent formatting. |
15 | | - |
16 | | -## Code Style |
17 | | - |
18 | | -[![standard][standard-image]][standard-url] |
19 | | - |
20 | | -This repository uses [`standard`][standard-url] to maintain code style and consistency, |
21 | | -and to avoid style arguments. `npm test` runs `standard` automatically, so you don't have |
22 | | -to! |
23 | | - |
24 | | -## Project Governance |
25 | | - |
26 | | -Individuals making significant and valuable contributions are given commit-access to the project to contribute as they see fit. This project is more like an open wiki than a standard guarded open source project. |
27 | | - |
28 | | -### Rules |
29 | | - |
30 | | -There are a few basic ground-rules for contributors: |
31 | | - |
32 | | -1. **No `--force` pushes** or modifying the Git history in any way. |
33 | | -2. **Non-master branches** should be used for ongoing work. |
34 | | -3. **Significant modifications** like API changes should be subject to a **pull request** to solicit feedback from other contributors. |
35 | | -4. **Pull requests** are *encouraged* for all contributions to solicit feedback, but left to the discretion of the contributor. |
36 | | - |
37 | | -### Releases |
38 | | - |
39 | | -Declaring formal releases remains the prerogative of the project maintainer. |
40 | | - |
41 | | -### Changes to this arrangement |
42 | | - |
43 | | -This is an experiment and feedback is welcome! This document may also be subject to pull-requests or changes by contributors where you believe you have something valuable to add or change. |
44 | | - |
45 | | -## Developer's Certificate of Origin 1.1 |
46 | | - |
47 | | -By making a contribution to this project, I certify that: |
48 | | - |
49 | | -- (a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or |
50 | | - |
51 | | -- (b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or |
52 | | - |
53 | | -- (c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it. |
54 | | - |
55 | | -- (d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved. |
56 | | - |
57 | | -[standard-image]: https://cdn.rawgit.com/feross/standard/master/badge.svg |
58 | | -[standard-url]: https://github.com/feross/standard |
| 1 | +You want to help? You rock! Now, take a moment to be sure your contributions make sense to everyone else. |
| 2 | + |
| 3 | +## Reporting Issues |
| 4 | + |
| 5 | +Found a problem? Want a new feature? |
| 6 | + |
| 7 | +- See if your issue or idea has [already been reported]. |
| 8 | +- Provide a [reduced test case] or a [live example]. |
| 9 | + |
| 10 | +Remember, a bug is a _demonstrable problem_ caused by _our_ code. |
| 11 | + |
| 12 | +## Submitting Pull Requests |
| 13 | + |
| 14 | +Pull requests are the greatest contributions, so be sure they are focused in scope, and do avoid unrelated commits. |
| 15 | + |
| 16 | +1. To begin, [fork this project], clone your fork, and add our upstream. |
| 17 | + ```bash |
| 18 | + # Clone your fork of the repo into the current directory |
| 19 | + git clone https://github.com/<your-username>/PLUGIN_NAME |
| 20 | + # Navigate to the newly cloned directory |
| 21 | + cd PLUGIN_NAME |
| 22 | + # Assign the original repo to a remote called "upstream" |
| 23 | + git remote add upstream https://github.com/GITHUB_NAME/PLUGIN_NAME |
| 24 | + # Install the tools necessary for development |
| 25 | + npm install |
| 26 | + ``` |
| 27 | + |
| 28 | +2. Create a branch for your feature or fix: |
| 29 | + ```bash |
| 30 | + # Move into a new branch for a feature |
| 31 | + git checkout -b feature/thing |
| 32 | + ``` |
| 33 | + ```bash |
| 34 | + # Move into a new branch for a fix |
| 35 | + git checkout -b fix/something |
| 36 | + ``` |
| 37 | + |
| 38 | +3. Be sure your code follows our practices. |
| 39 | + ```bash |
| 40 | + # Test current code |
| 41 | + npm run test |
| 42 | + ``` |
| 43 | + |
| 44 | +4. Push your branch up to your fork: |
| 45 | + ```bash |
| 46 | + # Push a feature branch |
| 47 | + git push origin feature/thing |
| 48 | + ``` |
| 49 | + ```bash |
| 50 | + # Push a fix branch |
| 51 | + git push origin fix/something |
| 52 | + ``` |
| 53 | + |
| 54 | +5. Now [open a pull request] with a clear title and description. |
| 55 | + |
| 56 | +[already been reported]: issues |
| 57 | +[fork this project]: fork |
| 58 | +[live example]: http://codepen.io/pen |
| 59 | +[open a pull request]: https://help.github.com/articles/using-pull-requests/ |
| 60 | +[reduced test case]: https://css-tricks.com/reduced-test-cases/ |
0 commit comments