0ct0pu5/kafka-ui
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update contributing guidelines (#731)

Browse source 
* Update CONTRIBUTING.md guidelines

* More edits
This commit is contained in:
Roman Zabaluev 2021-08-19 14:49:21 +03:00 • committed by GitHub
parent 03ed67db89
commit 8f625367b3
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 35 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

42
CONTRIBUTING.md
View file

@ -1,16 +1,44 @@
# Contributing
When contributing to this repository, please first discuss the change you wish to make via issue,
email, or any other method with the owners of this repository before making a change.
email, or any other method with the maintainers of the repository before making a change.
Please note we have a code of conduct, please follow it in all your interactions with the project.
Please note we have a code of conduct (`CODE-OF-CONDUCT.md`), please follow it in all your interactions with the project.
## Pull Request Process
1. Ensure any install or build dependencies are removed before the end of the layer when doing a
### General rules
1. Ensure any install or build dependencies have been removed before the end of the layer when composing a
build.
2. Update the README.md with details of changes to the interface, this includes new environment
2. Update the `README.md` with details of changes to the interface, this includes new environment
variables, exposed ports, useful file locations and container parameters.
3. Start Pull Request name with issue number (ex. #123)
4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you
do not have permission to do that, you may request the second reviewer to merge it for you.
3. Start a pull request name with issue number (ex. #123).
4. You may merge the pull request once you have the approval of two other developers. In case you
don't have permissions to do that, you may request the second reviewer to merge it for you.
### Branch naming
In order to keep branch names understandable and similar please use the corresponding branch naming conventions.
Generally speaking, it's a good idea to add a group/type prefix for a branch, e.g.,
if you're working on a specific branch you could name your branch `issues/xxx`.
Here's a list of good examples:<br/>
`issues/123`<br/>
`feature/feature_name`<br/>
`bugfix/fix_thing`<br/>
### Code style
There's a file called `checkstyle.xml` in project root under `etc` directory.<br/>
You can import it into IntelliJ IDEA via checkstyle plugin.
### Naming conventions
REST paths should be **lowercase** and consist of just **plural** nouns.<br/>
Also, multiple words in a single path segment should be divided by a hyphen symbol (`-`).<br/>
Query variable names should be formatted in `camelCase`.
Model names should consist of just **plural** nouns and should be formatted in `camelCase` as well.