CONTRIBUTING: Clarify some constraints for PR submission.#1134
Open
agatti wants to merge 1 commit into
Open
Conversation
This commit updates the contribution guidelines to clarify some points related to submitting PRs in a way that wouldn't fail basic CI checks. The contribution guidelines assumed that all PRs would come from a properly set-up environment, which it may not always be the case for small changes being done from within GitHub itself. However these PRs would not undergo the checks provided by the pre-commit hooks that are set up in a properly set-up environment. These changes aim to dissuade users who read the guidelines first to submit PRs from GitHub directly but to do so from a configured environment, and if that is not the case to at least make explicit the commit message validation criteria. There isn't much to do for code formatting rules besides saying to use "ruff" first, unfortunately. Signed-off-by: Alessandro Gatti <a.gatti@frob.it>
915a6ec to
c1512dd
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR updates the contribution guidelines to clarify some points related to submitting PRs in a way that wouldn't fail basic CI checks.
The contribution guidelines assumed that all PRs would come from a properly set-up environment, which it may not always be the case for small changes being done from within GitHub itself. However these PRs would not undergo the checks provided by the pre-commit hooks that are set up in a properly set-up environment.
These changes aim to dissuade users who read the guidelines first to submit PRs from GitHub directly but to do so from a configured environment, and if that is not the case to at least make explicit the commit message validation criteria. There isn't much to do for code formatting rules besides saying to use "ruff" first, unfortunately.
This PR was inspired by the brief discussion in #1077 - not to single the PR out - as the guidelines weren't clear on certain points and we end up with a PR that, whilst it fixed an existing issue, cannot be merged for reasons that may not be explicit enough.
Generative AI
I did not use generative AI tools when creating this PR.