diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index f06d37e9e14..d707b6c8848 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -11,7 +11,9 @@ Remove this section if not relevant ### Merge requirements satisfied? **[NOTICE] Bug fixes or features added to Salt require tests.** - + - [ ] Docs - [ ] Changelog - https://docs.saltproject.io/en/master/topics/development/changelog.html - [ ] Tests written/updated @@ -19,7 +21,13 @@ Remove this section if not relevant ### Commits signed with GPG? Yes/No -Please review [Salt's Contributing Guide](https://docs.saltproject.io/en/master/topics/development/contributing.html) for best practices, including the -[PR Guidelines](https://docs.saltproject.io/en/master/topics/development/pull_requests.html). + -See GitHub's [page on GPG signing](https://help.github.com/articles/signing-commits-using-gpg/) for more information about signing commits with GPG. + + + diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 5379f448572..c9c459ef558 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -1,30 +1,56 @@ -============ -Contributing -============ +============================================== +Contributing to Salt: A Guide for Contributors +============================================== -So you want to contribute to the Salt project? Excellent! You can help -in a number of ways: +So, you want to contribute to the Salt project? That's fantastic! There are many +ways you can help improve Salt: -- Use Salt and open well-written bug reports. -- Join a `working group `__. -- Answer questions on `irc `__, - the `community Discord `__, - the `salt-users mailing - list `__, - `Server Fault `__, - or `r/saltstack on Reddit `__. -- Fix bugs. -- `Improve the documentation `__. -- Provide workarounds, patches, or other code without tests. -- Tell other people about problems you solved using Salt. +- Use Salt and report bugs with clear, detailed descriptions. +- Join a `working group `__ to + collaborate with other contributors. +- Answer questions on platforms like `IRC `__, + the `community Discord `__, + the `salt-users mailing list `__, + `Server Fault `__, + or `r/saltstack on Reddit `__. +- Fix bugs or contribute to the `documentation `__. +- Submit workarounds, patches, or code (even without tests). +- Share your experiences and solutions to problems you've solved using Salt. -If you'd like to update docs or fix an issue, you're going to need the -Salt repo. The best way to contribute is using -`Git `__. +Choosing the Right Branch for Your Pull Request +=============================================== +We appreciate your contributions to the project! To ensure a smooth and +efficient workflow, please follow these guidelines when submitting a Pull +Request. Each type of contribution—whether it's fixing a bug, adding a feature, +updating documentation, or fixing tests—should be targeted at the appropriate +branch. This helps us manage changes effectively and maintain stability across +versions. + +- **Bug Fixes:** + + Create your Pull Request against the oldest supported branch where the bug + exists. This ensures that the fix can be applied to all relevant versions. + +- **New Features**: + + For new features or enhancements, create your Pull Request against the master + branch. + +- **Documentation Updates:** + + Documentation changes should be made against the master branch, unless they + are related to a bug fix, in which case they should follow the same branch as + the bug fix. + +- **Test Fixes:** + + Pull Requests that fix broken or failing tests should be created against the + oldest supported branch where the issue occurs. + +Setting Up Your Salt Development Environment +============================================ -Environment setup -================= To hack on Salt or the docs you're going to need to set up your development environment. If you already have a workflow that you're comfortable with, you can use that, but otherwise this is an opinionated diff --git a/doc/topics/development/pull_requests.rst b/doc/topics/development/pull_requests.rst index 4b6ffee9135..c1cb30a035c 100644 --- a/doc/topics/development/pull_requests.rst +++ b/doc/topics/development/pull_requests.rst @@ -193,12 +193,21 @@ By default, PRs run a limited subset of the test suite against the following operating systems: * Linux: + - Latest ``Amazon Linux Arm64`` + - Latest ``Amazon Linux x86_64`` + - Latest ``Debian Linux Arm64`` + - Latest ``Debian Linux x86_64`` + - Latest ``Photon OS Arm64`` + - Latest ``Photon OS x86_64`` + - Latest ``Rocky Linux Arm64`` - Latest ``Rocky Linux x86_64`` - - Latest ``Amazon Linux aarch64`` - - Latest ``Ubuntu LTS arm64`` - - Latest ``Arch Linux x86_64`` -* Latest ``Windows Server x86_64`` -* Latest ``MacOS arm64`` + - Latest ``Ubuntu LTS Arm64`` + - Latest ``Ubuntu LTS x86_64`` +* Windows Server: + - Latest ``Windows Server x86_64`` +* macOS: + - Latest ``MacOS Arm64`` + - Latest ``MacOS x86_64`` Optional OS additions ---------------------