Hi! Thanks for taking the time to contribute to this project. Below, you will find our set of instructions/guidelines for contributing to this project.
Everyone who contributes to this project is expected to uphold our Code of Conduct. Please report all violations/concerns to [email protected].
If you notice a bug in our project, please feel free to submit an issue with a detailed bug report. We pledge that someone on our team will be sure to get back to you within 3 business days. Guidelines for bug reports are below:
- Use a descriptive title with "Bug Report:" as the first thing.
- State when the problem started occurring.
- In the report, clearly state all steps taken to reproduce the bug. Document the exact sequence of actions taken to produce the bug. The bug should be reproduced 3 times.
- At each step, state the effect of the action taken.
- If applicable, clearly state all steps taken to isolate and generalize the bug. This will help developers figure out the origins of the bug.
- If applicable, attach pictures.
If you have an enhancement in mind, please feel free to submit an issue with a detailed suggestion of the enhancement. We pledge that someone on our team will be sure to get back to you within 3 business days. Guidelines for enhancement suggestions are below:
- Use a descriptive title with "Enhancement:" as the first thing.
- In the suggestion, clearly state the suggested enhancement.
- Detail what aspect of the program you'd like to change.
- Detail how the enhancement would benefit the program.
- If applicable, attach pictures.
This project uses pull requests to maintain the contiguous integration process and to maintain quality. Once you have made changes and are ready to create a pull request, use the following style guidelines.
All questions can be directed to [email protected]!
Use the following guidelines when committing to this project:
- Separate the subject and body of the commit.
- Use present tense.
- Subject line should be less than 50 characters.
- Subject line should summarize changes.
- Body should describe why/how if necessary.
- Ensure all code is well commented.
If you discover a security flaw in our project, do not create a bug report. Since bug reports are public, the vulnerability could be exploited by others. Instead, email us at [email protected]. Use the following guidelines:
- Use a descriptive subject line with "URGENT Security Flaw:" as the first thing.
- State when you noticed the flaw.
- If applicable, clearly state all steps taken to reproduce the flaw. Document the exact sequence of actions taken to produce the flaw. The flaw should be reproduced 3 times.
- Descriptively state the impact of the security flaw.
- If applicable, attach pictures.