From d1c2c1c565f68bd44d4bcdec37a0f3ccb8444fca Mon Sep 17 00:00:00 2001 From: Dominic R Date: Tue, 9 Dec 2025 18:12:17 -0500 Subject: [PATCH] contributing: don't use main branch (#18688) * contributing: don't use main branch * lint * Apply suggestion from @dominic-r Signed-off-by: Dominic R --------- Signed-off-by: Dominic R --- .github/pull_request_template.md | 4 ++++ website/docs/developer-docs/contributing.md | 18 ++++++++++++++++++ 2 files changed, 22 insertions(+) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index ad15eba9eb..2cc26c16be 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -2,6 +2,10 @@ 👋 Hi there! Welcome. Please check the Contributing guidelines: https://docs.goauthentik.io/docs/developer-docs/#how-can-i-contribute + +⚠️ IMPORTANT: Make sure you are opening this PR from a FEATURE BRANCH, not from your main branch! +If you opened this PR from your main branch, please close it and create a new feature branch instead. +For more information, see: https://docs.goauthentik.io/developer-docs/contributing/#always-use-feature-branches --> ## Details diff --git a/website/docs/developer-docs/contributing.md b/website/docs/developer-docs/contributing.md index 71c954e190..6edb4cec4f 100644 --- a/website/docs/developer-docs/contributing.md +++ b/website/docs/developer-docs/contributing.md @@ -137,6 +137,24 @@ The process described here has several goals: - Engage the community in working toward the best possible authentik - Enable a sustainable system for authentik's maintainers to review contributions +#### Always use feature branches + +**DO NOT open pull requests from your `main` branch.** Always create a feature branch for your changes. + +Here's one way to do it correctly (your own preferred git commands may differ): + +```bash +# Create and switch to a new feature branch +git checkout -b feature/my-awesome-feature + +# Make your changes, then commit and push +git add . +git commit -m "providers/oauth2: add awesome feature" +git push -u origin feature/my-awesome-feature +``` + +Then open your PR from the feature branch. + Please follow these steps to have your contribution considered by the maintainers: 1. Follow the [style guides](#style-guides)