Skip to content

Latest commit

 

History

History
71 lines (46 loc) · 2.46 KB

CONTRIBUTOR.md

File metadata and controls

71 lines (46 loc) · 2.46 KB

Contributing

Thanks for considering contributing to TreeifyTask!

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change. Please note we have a code of conduct, please follow it in all your interactions with the project.

Opening issues

If you find a bug, please feel free to open an issue.

If you taking the time to mention a problem, even a seemingly minor one, it is greatly appreciated, and a totally valid contribution to this project. Thank you!

Pull Request Process

  1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
  2. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
  3. Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent. The versioning scheme we use is SemVer.
  4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.

Fixing bugs

We love pull requests. Here’s a quick guide:

  1. Fork this repository and then clone it locally:
git clone https://github.com/intuit/TreeifyTask
  1. Create a topic branch for your changes:
git checkout -b fix-for-that-thing
  1. Commit a failing test for the bug:
git commit -am "Adds a failing test to demonstrate that thing"
  1. Commit a fix that makes the test pass:
git commit -am "Adds a fix for that thing!"
  1. Run the tests:
dotnet test
  1. If everything looks good, push to your fork:
git push origin fix-for-that-thing
  1. Submit a pull request.

  2. Enjoy being the wonderful person you are

After you’ve opened your pull request, you should email me your mailing address so I can mail you to thank you first and then start a personal conversation.

Adding new features

Thinking of adding a new feature? Cool! Open an issue and let’s design it together.