Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a pull request template with some basic guidelines #4055

Merged
merged 2 commits into from
Aug 25, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions .github/pull_request_template.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
Please check the following tips:

1. Avoid using force-push and commands that require it (such as `commit --amend` and `rebase origin/main`). This makes it more difficult for the maintainers to review your work. Add new commits on top of the current branch, and merge the new state of `main` into your branch with plain `merge`.

2. Provide a meaningful title for this pull request. It will be used as the commit message when this pull request is merged. Add as many commits as you like with any messages you like, they will be squashed into one commit.

3. If this pull request fixes an issue, refer to the issue with messages like `Ref #1234`, `Closes #1234`, or `Fixes #1234` in the pull description.

4. Please check that you are targeting the `main` branch. Pull requests on release branches are only allowed for backports.

5. Make sure you have read contribution guidelines: https://woodpecker-ci.org/docs/development/getting-started

6. It is recommended to enable "Allow edits by maintainers", so maintainers can help you more easily.

Make sure to remove these tips (or replace them with a description) after you have read them.