Skip to content

Latest commit

 

History

History
33 lines (24 loc) · 1.7 KB

CONTRIBUTING.rst

File metadata and controls

33 lines (24 loc) · 1.7 KB
Raw

Contributing to pywws

If you would like to add a feature to pywws (or fix a problem with it) then please do. Open source software thrives when its users become active contributors. The process is quite simple:

  1. Join GitHub - it's free.

  2. Fork the pywws repo - see Fork a Repo for help.

  3. Clone your fork to a computer you can use to develop your new feature.

  4. Use git to commit changes as you make them and push the changes to your fork of pywws.

    Please add a signed-off-by line to your commits which certify your developer certificate of origin (see below). For example, if your name is “John Smith”, and your email address is "jsmith@example.com", just include the following line at the bottom of your commit messages:

    Signed-off-by: John Smith <jsmith@example.com>

    You should be able to do this automatically by using the -s option on your git commit commands.

  5. Add your name and email to the src/contributors/contributors.txt file. Don't forget the -s option when you commit this change.

  6. Test your changes!

  7. When everything's working as you expect, submit a Pull Request.

Developer Certificate of Origin

Including a signed-off-by line in your commits indicates that you certify the following:

Clauses (a), (b) and (c) reassure pywws users that the project will remain open source well in to the future. Clause (d) reminds you that your contributions will be publicly available, and you do not have the right to withdraw them in future.