👍🎉 First off, thanks for taking the time to contribute! 🎉👍
The following is a set of guidelines for contributing to test-automation-bootstrap. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
Questions and/or discussions are tracked as issues. Fill in the template.
Bug reports are tracked as issues. Fill in the template, the information it asks for helps to 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.
Enhancement suggestions are tracked as issues. Fill in the template, including the steps that you imagine you would take if the feature you're requesting existed.
Unsure where to begin contributing? You can start by looking for utils methods or classes you would like to see implemented:
- Database connections (e.g. MongoDB, PostgreSQL)
- File readers (e.g. Excel, PDF)
The process described here has several goals:
- Maintain test-automation-bootstrap's quality
- Fix problems that are important to users
- Engage the community in working toward the best possible test automation template ✨
- Enable a sustainable system for maintaining and review contributions
Please follow these steps to have your contribution considered:
- Follow all instructions in the template
- Follow the styleguide
- 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. If it's concluded that the failure was a false positive, then an issue will be opened to track that problem.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
- Consider starting the commit message with an applicable emoji:
- ☀️
:sun:when adding a new feature - 🐛
:bug:when fixing a bug - 🔥
:fire:when removing code or files - 🤖
:robot:when fixing the CI build - ✅
:white_check_mark:when adding tests - ⬆️
:arrow_up:when upgrading dependencies - ⬇️
:arrow_down:when downgrading dependencies
- ☀️