First off, thanks for taking the time to contribute! We are really glad you're reading this, because we need volunteer developers to help this project come to fruition.
When contributing to this repository, please first discuss the change you wish to make via issue.
Please note we have a code of conduct, please follow it in all your interactions with the project.
File an issue to ask a question.
Do you find a bug?
- Ensure that the bug was not already reported by searching it under issues
- If you do not find an open issue, open a new one. Be sure to include a title and clear description and as much relevant information as possible including a code sample or an executable test case that demonstrate the problem.
Did you write a patch that fixes a bug?
- Open a new GitHub pull request with the patch
- Ensure that the description of the pull request describes the problem and the solution. If applicatble, include the relevant issue number.
- Open a new GitHub pull request with the new feature.
- Ensure that the description of the pull request includes a clear description of the enhancement.
Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should look like this:
$ git commit -m "A brief summary of the commit
>
> A paragraph describing what changed and its impact."
Always double check that the pull request dos not crash the build of the project
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
Examples of behavior that contributes to creating a positive environment include:
- Using welcoming and inclusive language
- Being respectful of differing viewpoints and experiences
- Gracefully accepting constructive criticism
- Focusing on what is best for the community
- Showing empathy towards other community members
Examples of unacceptable behavior by participants include:
- The use of sexualized language or imagery and unwelcome sexual attention or advances
- Trolling, insulting/derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or electronic address, without explicit permission
- Other conduct which could reasonably be considered inappropriate in a professional setting
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the maintenance team.
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
This Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at http://contributor-covenant.org/version/1/4 as well as from the OpenGovernment Project and the Atom Project.