Permalink
Browse files

Create CONTRIBUTING.md (#237)

  • Loading branch information...
ahmetcetin authored and alexarchambault committed Oct 5, 2018
1 parent 287ef36 commit 51a43471d81e89c5154651d67da46e95ff8482dd
Showing with 31 additions and 0 deletions.
  1. +31 −0 CONTRIBUTING.md
View
@@ -0,0 +1,31 @@
# Contributing to almond
Contributing to almond isn't limited to just filing bugs, users are more than welcomed to make suggestions, report any issue they may find, and make pull requests to help make almond better.
## Working on almond
### Prerequisites
* [Git](https://git-scm.com/)
### Getting almond
1. Fork a copy of our repo
2. Open up Git in an environment of your choice
3. Run the following
```
$ git clone https://github.com/YOUR-GITHUB-PROFILE-NAME/almond.git
$ cd almond
```
### Please pay attention to
1. open an issue describing the feature/bug you wish to contribute first to start a discussion, explain why, what and how
2. follow the eslint rules
3. write tests covering 100% of the library code you produce
4. one PR per feature/fix unless you follow [standard-version](https://github.com/conventional-changelog/standard-version) commit guidelines
### Using branches
When working on any issue on Github, it's a good practice to make branches that are specific to the issue you're currently working on. For instance, if you're working on an issue with a name like "NAME OF ISSUE #1234", from the master branch run the following code: `git checkout -b Issue#1234`. In doing so, you'll be making a branch that specifically identifies the issue at hand, and moves you right into it with the `checkout` flag. This keeps your main (master) repository clean and your personal workflow cruft out of sight when making a pull request.
### Finding issues to fix
After you've forked and cloned our repo, you can find issues to work on by heading over to our [issues list](https://github.com/almond-sh/almond/issues). We advise looking at the issues with the labels [help wanted](https://github.com/almond-sh/almond/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) or [good first issue](https://github.com/almond-sh/almond/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22), as they will help you get familiar with the almond code.
### Rules of the discussions
Remember to be very clear and transparent when discussing any issue in the discussions boards. We ask that you keep the language to English and keep on track with the issue at hand. Lastly, please be respectful of our fellow contributors and keep an exemplary level of professionalism at all times.

0 comments on commit 51a4347

Please sign in to comment.