👍🎉 First off, thanks for taking the time to contribute! 🎉👍
The following is a set of guidelines for contributing to Priority Based Alert System for Visually Impaired. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
This project and everyone participating in it is governed by the Project's Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to pictairesearch@gmail.com.
This section guides you through submitting a bug report for the project. Following these guidelines helps maintainers and the community understand your report 📝, reproduce the behavior 💻 💻, and find related reports 🔎.
Before creating bug reports, please check this list as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible. Fill out the required template, the information it asks for helps us resolve issues faster.
Note: If you find a Closed issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.
- Determine which module the problem should be reported in.
- Perform a cursory search to see if the problem has already been reported. If it has and the issue is still open, add a comment to the existing issue instead of opening a new one.
Bugs are tracked as GitHub issues. After you've determined which module your bug is related to, create an issue on that repository and provide the following information by filling in the template.
Explain the problem and include additional details to help maintainers reproduce the problem:
- Use a clear and descriptive title for the issue to identify the problem.
- Describe the exact steps which reproduce the problem in as many details as possible.
- Provide specific examples to demonstrate the steps. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, use Markdown code blocks.
- Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
- Explain which behavior you expected to see instead and why.
- Include screenshots and animated GIFs which show you following the described steps and clearly demonstrate the problem.
Include details about your configuration and environment:
- What's the name and version of the OS you're using?
- Which packages do you have installed? You can get that list by running
pip list.
The process described here has several goals:
- Maintain Project quality
- Fix problems that are important to users
- Enable a sustainable system for maintainers to review contributions
Please follow these steps to have your contribution considered by the maintainers:
- Follow all instructions in the template
- Follow the styleguides
- After you submit your pull request, verify that all status checks are passing
What if the status checks are failing?
If a status check is failing, and you believe that the failure is unrelated to your change, please leave a comment on the pull request explaining why you believe the failure is unrelated. A maintainer will re-run the status check for you. If we conclude that the failure was a false positive, then we will open an issue to track that problem with our status check suite.
While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted.
- Use the present tense ("Add feature" not "Added feature")
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
- Limit the first line to 72 characters or less
- Reference issues and pull requests liberally after the first line
- When only changing documentation, include
[ci skip]in the commit title - Consider starting the commit message with an applicable emoji:
- 🎨
:art:when improving the format/structure of the code - 🐎
:racehorse:when improving performance - 🚱
:non-potable_water:when plugging memory leaks - 📝
:memo:when writing docs - 🐧
:penguin:when fixing something on Linux - 🍎
:apple:when fixing something on macOS - 🏁
:checkered_flag:when fixing something on Windows - 🐛
:bug:when fixing a bug - 🔥
:fire:when removing code or files - ✅
:white_check_mark:when adding tests - 🔒
:lock:when dealing with security - ⬆️
:arrow_up:when upgrading dependencies - ⬇️
:arrow_down:when downgrading dependencies - 👕
:shirt:when removing linter warnings
- 🎨
- Use Markdown.
This section lists the labels we use to help us track and manage issues and pull requests.
GitHub search makes it easy to use labels for finding groups of issues or pull requests you're interested in.
| Label name | Description |
|---|---|
enhancement |
Feature requests. |
bug |
Confirmed bugs or reports that are very likely to be bugs. |
question |
Questions more than bug reports or feature requests (e.g. how do I do X). |
feedback |
General feedback more than bug reports or feature requests. |
help-wanted |
The core team would appreciate help from the community in resolving these issues. |
beginner |
Less complex issues which would be good first issues to work on for users who want to contribute to Project. |
more-information-needed |
More information needs to be collected about these problems or feature requests (e.g. steps to reproduce). |
needs-reproduction |
Likely bugs, but haven't been reliably reproduced. |
blocked |
Issues blocked on other issues. |
duplicate |
Issues which are duplicates of other issues, i.e. they have been reported before. |
wontfix |
The core team has decided not to fix these issues for now, either because they're working as intended or for some other reason. |
invalid |
Issues which aren't valid (e.g. user errors). |
package-idea |
Feature request which might be good candidates for new packages, instead of extending packages. |
| Label name | Description |
|---|---|
windows |
Related to running on Windows. |
linux |
Related to running on Linux. |
mac |
Related to running on macOS. |
documentation |
Related to any type of documentation. |
performance |
Related to performance. |
security |
Related to security. |
ui |
Related to visual design. |
uncaught-exception |
Issues about uncaught exceptions. |
crash |
Reports of Project completely crashing. |
auto-indent |
Related to auto-indenting text. |
network |
Related to network problems or working with remote files (e.g. on network drives). |
git |
Related to Git functionality (e.g. problems with gitignore files or with showing the correct file status). |
| Label name | Description |
|---|---|
work-in-progress |
Pull requests which are still being worked on, more changes will follow. |
needs-review |
Pull requests which need code review, and approval from maintainers core team. |
under-review |
Pull requests being reviewed by maintainers core team. |
requires-changes |
Pull requests which need to be updated based on review comments and then reviewed again. |
needs-testing |
Pull requests which need manual testing. |