diff --git a/contribute.md b/contribute.md index fd5f8da..bb3e8e3 100644 --- a/contribute.md +++ b/contribute.md @@ -5,21 +5,23 @@ Thank you for considering contributing to our project! We welcome contributions ## Issue Tracking -Please check our [issue tracker](https://github.com/AlabamaWaterInstitute/CloudInfra/issues) for existing issues that you can work on. If you find a new issue or have a feature request, please open a new issue so we can discuss it and prioritize it accordingly. +Please check our [issue tracker](https://github.com/CIROH-UA/NGIAB-CloudInfra/issues) for existing issues that you can work on. If you find a new issue or have a feature request, please open a new issue so we can discuss it and prioritize it accordingly. ## How to Contribute +1. If an Issue does not already exist, you can use the [bug report template](https://github.com/CIROH-UA/NGIAB-CloudInfra/issues/new?assignees=&labels=bug&projects=&template=bug_report.md&title=) to create one. -1. Fork the repository and clone it to your local machine. - -2. Create a new branch for your changes using the format "feature/``" or "bugfix/``". +2. Click on the “Create a branch” button to create a new branch. Choose the automatically selected branch. 3. Make your changes and commit them with clear and concise commit messages. -4. Push your changes to your forked repository. +4. Push your changes to the branch. + +5. Open a pull request from your branch to the repository with a clear and descriptive title and detailed description of your changes. -5. Open a pull request from your forked repository to our repository with a clear and descriptive title and detailed description of your changes. +6. Once your pull request is submitted, a PR validation CI pipeline will trigger that will validate the changes. -6. Once your pull request is submitted, it will be reviewed by the maintainers. You may be asked to make further changes before your contribution can be merged. +7. Please make sure that the PR pipeline is successful. +8. The maintainers of the repository will merge the PR upon successful CI workflow.