From bbb17ad9411dc517d6f642cecb9e6a921b01dd27 Mon Sep 17 00:00:00 2001 From: Stian Thorgersen Date: Mon, 8 Nov 2021 13:18:09 +0100 Subject: [PATCH] Update CONTRIBUTING.md --- CONTRIBUTING.md | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e2c474a576..8960511186 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,11 +16,11 @@ discussion first. For minor changes you can skip this part and go straight ahead Here's a quick checklist for a good PR, more details below: 1. A discussion around the change (https://github.com/keycloak/keycloak/discussions/categories/ideas) -2. A JIRA with a good description associated with the PR +2. A GitHub Issue with a good description associated with the PR 3. One feature/change per PR 4. One commit per PR 5. PR rebased on main (`git rebase`, not `git pull`) -5. Commit message is prefixed by JIRA number +5. Commit message is prefixed by the issue number (for example `#58 Message`) 6. No changes to code not directly related to your PR 7. Includes functional/integration test 8. Includes documentation @@ -47,16 +47,14 @@ The [Keycloak Dev Mailing List](https://groups.google.com/forum/#!forum/keycloak For very large proposals it can be inefficient to capture all the information in the GitHub Discussion. In this cases a separate design proposal can be sent to the [Keycloak Community repository](https://github.com/keycloak/keycloak-community/tree/main/design), and linked to from the GitHub Discussion. -### Create an issue in Keycloak JIRA +### Create an issue -Take your time to write a proper JIRA including a good summary and description. +Take your time to write a proper issue including a good summary and description. Remember this may be the first thing a reviewer of your PR will look at to get an idea of what you are proposing and it will also be used by the community in the future to find about what new features and enhancements are included in new releases. -Note: Keycloak Node.js Admin Client uses GitHub issues and not the Keycloak JIRA. - ### Implementing Details for building from source and working with the codebase are provided in the @@ -94,5 +92,5 @@ for more details. The above helps us review your PR and also makes it easier for us to maintain the repository. It is also required by our automatic merging process. -We also require that the commit message is prefixed with the Keycloak JIRA issue number (example commit message -"KEYCLOAK-9876 My super cool new feature"). +We also require that the commit message is prefixed with the issue number (example commit message +`#12 My super cool new feature`).