This is adapted from the Node.js contributor guidelines.
When reporting an issue with NoSE, please provide as much context as possible. At minimum, try running the tests and post the output of any failed tests. Also be sure to provide the version of the Ruby interpreter you are using.
This document will guide you through the contribution process.
Fork the project on GitHub and check out your copy locally.
$ git clone [email protected]:username/NoSE.git
$ cd NoSE
$ git remote add upstream git://github.com/michaelmior/NoSE.git
For developing new features and bug fixes, the master branch should be pulled
and built upon.
Create a feature branch and start hacking:
$ git checkout -b my-feature-branch -t origin/master
Make sure git knows your name and email address:
$ git config --global user.name "J. Random User"
$ git config --global user.email "[email protected]"
Writing good commit logs is important. A commit log should describe what changed and why. Follow these guidelines when writing one:
- The first line should be 50 characters or less and contain a short description of the change.
- Keep the second line blank.
- Wrap all other lines at 72 columns.
A good commit log can look something like this:
explaining the commit in one line
Body of commit message is a few lines of text, explaining things
in more detail, possibly giving some background about the issue
being fixed, etc. etc.
The body of the commit message can be several paragraphs, and
please do proper word-wrap and keep columns shorter than about
72 characters or so. That way `git log` will show things
nicely even when it is indented.
The header line should be meaningful; it is what other people see when they
run git shortlog or git log --oneline.
Use git rebase (not git merge) to sync your work from time to time.
$ git fetch upstream
$ git rebase upstream/master
Bug fixes and features should come with tests. Add your tests in the
spec directory. Look at other tests to see how they should be
structured.
$ bundle exec rspec
Make sure that all tests pass. Please, do not submit patches with failing tests.
If you are updating tests and just want to run a single test to check it, you can use this syntax:
$ bundle exec rspec spec/backend_spec.rb
$ git push origin my-feature-branch
Go to https://github.com/yourusername/NoSE and select your feature branch.
Click the 'Pull Request' button and fill out the form.
Pull requests are usually reviewed within a few days. If there are comments to address, apply your changes in a separate commit and push that to your feature branch. Post a comment in the pull request afterwards; GitHub does not send out notifications when you add commits.
By making a contribution to this project, I certify that:
-
(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
-
(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
-
(c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.
-
(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.