Skip to content

Latest commit

 

History

History
38 lines (27 loc) · 2.27 KB

CONTRIBUTING.md

File metadata and controls

38 lines (27 loc) · 2.27 KB
Raw

Contributing to JustSaying

❤️ JustSaying and want to get involved? Great! There are plenty of ways you can help!

If you find a bug, have a feature request or even want to contribute an enhancement or fix, please follow the below guidelines so that we can help you out and/or get your code merged quickly.

If you find what looks like a bug

  • Check the GitHub issue tracker to see if anyone else has reported the same issue.
  • Make sure you are using the latest version of JustSaying
  • If you are still having problems then create an issue with enough information so that it can be reproduced and diagnosed

If you want to contribute an enhancement or a fix

  1. Discuss any major enhancement with the project maintainers by creating either an issue or a discussion.
  2. Work on your changes and add any relevant unit and/or functional tests.
  3. Write or modify any relevant documentation.
  4. Ensure that code builds, the tests pass and your documentation is complete.

General Contribution Guidelines

We follow the standard GitHub fork & pull request approach to open source collaboration. You can find an awesome description on how this works on the gun.io blog.

In a nutshell:

  1. Fork JustSaying to your own GitHub account.
  2. Create your feature branch (git checkout -b feature/my-new-feature).
  3. Commit your changes (git commit -am 'Add some feature') and reference any issues.
  4. Push to your branch (git push origin my-new-feature).
  5. Send a new Pull Request describing what you have done and why, in detail.

Note

By submitting a patch, you agree to allow the project owners to license your work under the the terms of the Apache 2.0 license.

A copy of this license is provided in the root of the repository.