libre.sh/keycloak-scim
3
0
Fork 0
Code Issues 15 Pull requests Releases 1 Packages Activity Actions

Update CONTRIBUTING.md

Browse source
This commit is contained in:
Stian Thorgersen 2021-11-08 13:18:09 +01:00 committed by GitHub
parent 70702f6bdb
commit bbb17ad941
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
CONTRIBUTING.md
View file

@ -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: 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) 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 3. One feature/change per PR
4. One commit per PR 4. One commit per PR
5. PR rebased on main (`git rebase`, not `git pull`) 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 6. No changes to code not directly related to your PR
7. Includes functional/integration test 7. Includes functional/integration test
8. Includes documentation 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. 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 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 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. new releases.
Note: Keycloak Node.js Admin Client uses GitHub issues and not the Keycloak JIRA.
### Implementing ### Implementing
Details for building from source and working with the codebase are provided in the 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 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. our automatic merging process.
We also require that the commit message is prefixed with the Keycloak JIRA issue number (example commit message We also require that the commit message is prefixed with the issue number (example commit message
"KEYCLOAK-9876 My super cool new feature"). `#12 My super cool new feature`).