👍🎉 Thanks for taking the time to contribute! 🎉👍
The following is a set of guidelines for contributing to Jarvis, which is hosted in its GitHub repo. These are mostly guidelines, and not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
- PRs are accepted :)
- We follow PEP 8 formatting (official PEP 8). Before making a pull request ensure that your code is according to PEP 8 standards
- If you have some ideas for new features but don't have the time to implement them, please open an issue with the tag new_feature
- Don't forget to comment and add docstrings to your code where needed!
- Reporting Bugs
- Suggesting Enhancements
- Adding documentation
- Beginners: Your First Contribution
- Pull Requests
Here's some guidelines to help maintainers and the community understand your report 📝, reproduce the behavior 💻 💻, and find related reports 🔎.
Before creating bug reports, please check this list as you may find that you don't need to create one. When you are creating a bug report, please include as many details as possible.
Note: If you find a Closed issue that seems like it is the same problem you're experiencing, open a new issue and try and link to the original issue.
- Read the README and the documentation to check if you missed something.
- Check if you can reproduce the problem in the latest version of Jarvis.
- Perform a quick search in issues to see if the bug 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 recorded as issues. Explain the problem and include details to help maintainers reproduce the problem, and to help contributers fix it:
- Use a clear and descriptive title for the issue to identify the problem
- Describe the steps which produce the problem in as much detail as possible
- Describe what was wrong with the behavior you observed
- Explain which behavior you expected to see instead and why
- Can you reliably reproduce the issue? If not, provide details about how often the problem happens and under which conditions it normally happens
- Include details about your configuration and environment. What OS are you using? What command line program was Jarvis running in? The more detail the better
Following these guidelines helps maintainers and the community understand your suggestion 📝 and find related suggestions 🔎.
Before creating feature suggestions, please check this list. You may find that you don't need to create one. When creating a suggestion, include as many details as possible.
- Check if that feature already exists
- Check if you have the latest version of Jarvis
- Perform a quick search to see if the feature/enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
Enhancement suggestions are tracked as GitHub issues.
- Use a clear and descriptive title for the issue to identify the suggestion
- Use the tag new_feature in the issue
- Provide a description of the suggested feature
Every project benefits from having better documentation! With this in mind, Pull Requests that address documentation are welcome!
These contributions can be in many forms:
- Added/Improved docstrings and comments for functions/classes
- Added/Improved markdown files (README, CONTRIBUTING etc) that help visitors navigate the repository
These are the steps to take to successfully contribute code to the Jarvis repo:
- Find a potential contribution that you want to make. You can do this by either going throught the existing list of issues and picking one, or by opening a new issue.
- Assign it to yourself by commenting on the issue and saying that you will fix it.
Note: Remember to periodically comment an update on the issue to let everyone know that you're still working on it, or else someone else may take up the same issue.
- Fork the main branch so you have a repository on your Github called your_username/Jarvis.
- Make commits to this forked repository. You can clone this repository onto your computer and then push your commits to it, or take the less popular approach and make your commits directly in the forked Github repo.
- After finishing all your commits, squash them into a single commit if there's too many repetitive ones.
- In the forked repository, click on 'Pull Requests' and then make a new pull request. Make sure that you are comparing your repo, your_username/Jarvis to the main repo sukeesh/Jarvis.
- Submit the pull request. Refer to the pull requests section below to see details about them.
Congratulations! You've just made your first pull request!
Please follow these steps to have your contribution merged asap:
- Follow the styleguides
- Squash your commits into a single one if there's a lot of repetitive, similar commits.
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.
Follow common practices as described very well here.
Here's a quick summary:
- Write the first line of your commit in the imperative tense, not past tense.
- Write concise one line commits where possible.
- Write a body wherever needed.
- Make a commit for every logical change.
If you fixed a bug regarding Jarvis's speech, you'd phrase it:
'Fix bug regarding Jarvis speech' ✔️
'Fixed bug for speech' ❌
'Fixes speech' ❌
- Most importantly, when contributing to a file, follow the existing convention.
- If you're creating a new script follow the official styleguide.
Python Code: PEP 8
Python Comments and Docstrings: Google Guidelines
Markdown files: Follow the convention used in existing markdown files in the repository.