Unverified Commit 35e297bd authored by Victor Kropp's avatar Victor Kropp Committed by GitHub

improve contribution guidelines after discussion in compose-multiplatform repo (#1136)

parent 6d0165d2
...@@ -39,24 +39,20 @@ which will help keep your pull request simple and easy to apply. ...@@ -39,24 +39,20 @@ which will help keep your pull request simple and easy to apply.
Most of these rules are originated from the [How to Write a Git Commit Message](https://chris.beams.io/posts/git-commit/) Most of these rules are originated from the [How to Write a Git Commit Message](https://chris.beams.io/posts/git-commit/)
article, and it's highly recommended to read it. article, and it's highly recommended to read it.
### Rules on commit messages' content ### Rules on pull requests' description
1. Use the body to explain what and why vs. how 1. Explain what and why vs. how
* Please make an extra effort to explain why changes are needed for every non-trivial modification. * Please make an extra effort to explain why changes are needed for every non-trivial modification.
2. Significant commits must mention relevant [YouTrack](https://youtrack.jetbrains.com/issues/SKIKO) issues in their messages * Describe how you tested your changes
* Add Release Notes
2. Mention relevant [YouTrack](https://youtrack.jetbrains.com/issues/SKIKO) issues in their messages
3. Commit changes together with the corresponding tests, unless the resulting commit becomes too unwieldy to grasp 3. Commit changes together with the corresponding tests, unless the resulting commit becomes too unwieldy to grasp
4. Keep the subject (first line of the commit message) clean and readable. All additional information and directives for external tools
should be moved to the message body. ### Rules on PR messages style/formatting
### Rules on commit messages' style/formatting 1. Capitalize the title
2. Do not end the title with a period
1. Separate subject from body with a blank line 3. Use the imperative mood in the title
2. Capitalize the subject line
3. Do not end the subject line with a period
4. Use the imperative mood in the subject line
5. Limit the commit messages lines to 72 characters
* Use “Commit Message Inspections” in IntelliJ IDE *Settings -> Version Control -> Commit*
* vim: ```autocmd FileType gitcommit setlocal textwidth=72```
## Checklist ## Checklist
......
...@@ -10,6 +10,9 @@ with these PGP keys: ...@@ -10,6 +10,9 @@ with these PGP keys:
* Fingerprint: **2072 3A63 99BC 0601 5428 3B37 CFAE 163B 64AC 9189** * Fingerprint: **2072 3A63 99BC 0601 5428 3B37 CFAE 163B 64AC 9189**
* Key type: **ed25519** * Key type: **ed25519**
* Follow the Gradle [Dependency Verification Guide](https://docs.gradle.org/current/userguide/dependency_verification.html)
to set up continuous verification or learn how to [manually verify a dependency](https://docs.gradle.org/current/userguide/dependency_verification.html#sec:manual-checking-dependency).
* Use the latest versions of your application's dependencies. If you need to use a specific version of a dependency, * Use the latest versions of your application's dependencies. If you need to use a specific version of a dependency,
periodically check if any new security vulnerabilities have been discovered. You can follow periodically check if any new security vulnerabilities have been discovered. You can follow
[the guidelines from GitHub](https://docs.github.com/en/code-security) [the guidelines from GitHub](https://docs.github.com/en/code-security)
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment