Skip to content

Commit a227f6b

Browse files
authored
Create CONTRIBUTING.md
1 parent d76cb9d commit a227f6b

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

CONTRIBUTING.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
2+
Thank you for contributing to async-transform!
3+
4+
## Reporting Bugs
5+
6+
To report a bug, please visit [GitHub Issues](/bigab/async-transform/issues).
7+
8+
When filing a bug, it is helpful to include small examples using tools like [JSBin][1] or [CodePen][2].
9+
10+
Search for previous tickets, if there is one add to that one rather than creating another.
11+
12+
## Contributing
13+
14+
When contributing, please include tests with new features or bug fixes in a feature branch until you're ready to submit the code for consideration; then push to the fork, and submit a pull request. More detailed steps are as follows:
15+
16+
1. Navigate to your clone of the async-transform repository - `cd /path/to/async-transform`
17+
2. Create a new feature branch - `git checkout -b some-fix`
18+
3. Make some changes
19+
4. Update tests to accomodate your changes
20+
5. Run tests (`npm test`) and make sure they pass
21+
6. Update the documentation if necessary
22+
7. Push your changes to your remote branch - `git push -u origin some-fix`
23+
8. Submit a pull request! Navigate to [Pull Requests](/bigab/async-transform/pulls) and click the 'New Pull Request' button. Fill in some details about your potential patch including a meaningful title. When finished, press "Send pull request".
24+
25+
[1]: https://jsbin.com/
26+
[2]: https://codepen.io/

0 commit comments

Comments
 (0)