Skip to content

Commit 35e297b

Browse files
authored
improve contribution guidelines after discussion in compose-multiplatform repo (#1136)
1 parent 6d0165d commit 35e297b

File tree

2 files changed

+14
-15
lines changed

2 files changed

+14
-15
lines changed

CONTRIBUTING.md

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -39,24 +39,20 @@ which will help keep your pull request simple and easy to apply.
3939
Most of these rules are originated from the [How to Write a Git Commit Message](https://chris.beams.io/posts/git-commit/)
4040
article, and it's highly recommended to read it.
4141

42-
### Rules on commit messages' content
42+
### Rules on pull requests' description
4343

44-
1. Use the body to explain what and why vs. how
44+
1. Explain what and why vs. how
4545
* Please make an extra effort to explain why changes are needed for every non-trivial modification.
46-
2. Significant commits must mention relevant [YouTrack](https://youtrack.jetbrains.com/issues/SKIKO) issues in their messages
46+
* Describe how you tested your changes
47+
* Add Release Notes
48+
2. Mention relevant [YouTrack](https://youtrack.jetbrains.com/issues/SKIKO) issues in their messages
4749
3. Commit changes together with the corresponding tests, unless the resulting commit becomes too unwieldy to grasp
48-
4. Keep the subject (first line of the commit message) clean and readable. All additional information and directives for external tools
49-
should be moved to the message body.
50-
51-
### Rules on commit messages' style/formatting
52-
53-
1. Separate subject from body with a blank line
54-
2. Capitalize the subject line
55-
3. Do not end the subject line with a period
56-
4. Use the imperative mood in the subject line
57-
5. Limit the commit messages lines to 72 characters
58-
* Use “Commit Message Inspections” in IntelliJ IDE *Settings -> Version Control -> Commit*
59-
* vim: ```autocmd FileType gitcommit setlocal textwidth=72```
50+
51+
### Rules on PR messages style/formatting
52+
53+
1. Capitalize the title
54+
2. Do not end the title with a period
55+
3. Use the imperative mood in the title
6056

6157
## Checklist
6258

SECURITY.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@ with these PGP keys:
1010
* Fingerprint: **2072 3A63 99BC 0601 5428 3B37 CFAE 163B 64AC 9189**
1111
* Key type: **ed25519**
1212

13+
* Follow the Gradle [Dependency Verification Guide](https://docs.gradle.org/current/userguide/dependency_verification.html)
14+
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).
15+
1316
* Use the latest versions of your application's dependencies. If you need to use a specific version of a dependency,
1417
periodically check if any new security vulnerabilities have been discovered. You can follow
1518
[the guidelines from GitHub](https://docs.github.com/en/code-security)

0 commit comments

Comments
 (0)