Hello and welcome to Tasties project. Please read these guidelines carefully. Following them will help us make the contribution process easy and effective for everyone involved.
To contribute to our project please download and install the following:
- git, recommended version: 2.38.1; git can be downloaded from: https://git-scm.com/book/en/v2/Getting-Started-Installing-Git
- Vagrant, recommended version: 2.3.2; Vagrant can be downloaded from: https://developer.hashicorp.com/vagrant/downloads
- VirtualBox(or other VM that works with "Vagrant"), recommended version: 6.1.38; VirtualBox can be downloaded from: https://www.virtualbox.org/wiki/Downloads
IMPORTANT NOTES:
- Not all versions of Vagrant and VirtualBox may work together as expected (especially the latest versions). Finding a different combination of versions for Vagrant and VirtualBox may solve some issues that may arise in loading up a Vagrant VM.
- Also note that Vagrant may not work on some machines (such as Apple M1-based machines), so please make sure that you can find a suitable solution.
Issues should be used to report problems in the main branch, request a new feature, or to propose potential changes.
Guidelines to creating a new issue:
- Before you create a new issue, please make sure that there is no existing issue which addresses the same purpose.
- Every issue should have a meaningful and concise title that clearly describes its purpose (do not include issue or line numbers).
- Every issue should have a meaningful and concise description that provides relevant information on the issue.
To create a pull request (PR) please follow these instructions:
- Create an issue, if an issue relevant to your PR wasn't created yet.
- If you have not already done so, create a fork of the main repository https://github.com/redhat-beyond/tasties in the GitHub account you intend to contribute from.
- If you already have your own fork, please make sure it is synced with the redhat-beyond/tasties repository.
- Clone or Pull your up-to-date fork to the main branch on your local repository.
- Make sure you have set up https://github.com/redhat-beyond/tasties.git in your working directory as the "upsream" remote, and your fork of it as the "origin" remote.
- Create a new branch from the up-to-date main branch in your local repository for your changes.
- Make your desired changes in your local repository.
- Commit your changes with a concise and accurate commit message.
- Make sure you have commited all your desired changes, and push your branch to "origin".
- Open a new PR for your changes (it's recommended that you follow the link git provides on pushing).
- Link your PR to a relevant issue. This can be done as follows. Issues can also help the team and mentors know what every member of the team is working on.
Our standards for pull requests (PRs) are:
PR mergeability:
- Only submit Python code that was created on a Vagrant VM through pipenv (make sure to update pipfiles if you introduced new dependencies, and commit your changes). This ensures proper version control.
- Test your created code locally (with flake8 running through pipenv on a Vagrant VM); Please submit code that passes CI tests locally, to avoid as much as possible a PR that fails CI tests.
- Make every effort to only sumbit PRs that do not break currently working programs and features or introduce bugs.
- Make every effort so that the commits in your PR will not cause conflicts with the branch that you want you PR to be merged with.
PR documentation and visibility:
- Every PR should have a meaningful and concise title that clearly describes its purpose (do not include issue or line numbers).
- Every PR should have a meaningful and concise description that provides relevant information on the PR.
- Every PR should be linked to an issue (or issues), to make its purpose clear and increase its visibility (see Issues).
- Assign other teammates as well as mentors as reviewers on your PR.
PR code review:
- Each PR requires the approval of at least two team members.
- Examine the PR carefully, and with respect to what it is supposed to achieve.
- If you want to request changes to specific lines in a file please use the "Start a review" button.
- If you want to request changes, mark your review as "Request changes" - please do not use a generic comment.
- Use polite, respectful and clear language when commenting on or reviewing a PR.
- If your PR recieved a request for changes or a comment, please notify the reviewer about your actions (what changes you made, or if you don't think they're necessary - why you think so).
Every PR will be tested by:
- A flake8 workflow to make sure the PR conforms to proper Python syntax and coding standards.
- Automatically checked by a CI system.
The maintainers are: Lior Noy, Nati Fridman, Shay Vatarescu and Kasem Alem.