Skip to content

Commit 05b34c7

Browse files
Move the contributing guide to the repo root
Update CONTRIBUTING.md Co-authored-by: Kacper Rzetelski <[email protected]>
1 parent f8bb2cd commit 05b34c7

File tree

1 file changed

+7
-22
lines changed

1 file changed

+7
-22
lines changed
Lines changed: 7 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,5 @@
11
# Contributing to Scylla Operator
22

3-
## Prerequisites
4-
5-
To develop Scylla Operator, ensure your environment has the following items configured:
6-
7-
1. [Go](https://golang.org/dl)
8-
* Check `go.mod` for minimal version requirement.
9-
2. Git client
10-
3. GitHub account
11-
123
## Initial Setup
134

145
### Fork the repository
@@ -55,27 +46,21 @@ To maintain a clean commit history, aim for a minimal number of logical commits.
5546

5647
### Commits and PRs
5748

58-
The first line of your commit message and PR title should summarize the change in one clear sentence that would be meaningful to a user of the Operator. The sentence should use a verb in its base form to describe the change, e.g. "Add support for XYZ." .
59-
Every release note is based on these first lines, so make them concise yet informative.
60-
61-
If you have more to say about the change, then enter a blank line and carry on the description.
62-
Remember to say why the change was needed - the commit itself shows what was changed.
49+
The **subject line** of your commit message **and the PR title** should summarize the change in one clear sentence that would be meaningful to a user of the Operator. The sentence should be **written in the imperative**, i.e. written as if giving a command or instruction, e.g. "Add support for XYZ". A properly formed Git commit subject line should always be able to complete the sentence "If applied, this commit will...", e.g. "If applied, this commit will **Add support for XYZ**".
50+
Changelog entries are verbatim PR titles, so make them concise yet informative.
6351

64-
Writing more is better than less. Comparing the behavior before the change to that after the change is beneficial.
65-
Imagine writing to yourself in 12 months when you've forgotten everything about what you just did, and you need to get up to speed quickly.
52+
Further details should be added after a blank line. Explain why the change was necessary, not just what was changed. In the general case, extensive descriptions are well-received. Comparing the behavior before and after the change is especially helpful. Write the message with the mindset that you’ll need to revisit the code in the future.
53+
If your PR fixes an issue, include "Resolves #1234" in the description, replacing "1234" with the issue number.
6654

67-
If the change fixes an issue, then write Fixes #1234 in the PR description.
68-
69-
Here is an example of a good commit message and PR title/description:
7055
```
71-
56+
**Description of your changes:**
7257
Add new XYZ field to ScyllaCluster CRD.
73-
7458
The new field allows for configuration of ZYX feature of ScyllaDB.
7559
<more details>
7660
API change was discussed in the following enhancement: <link>.
7761
78-
Fixes #1234
62+
**Which issue is resolved by this Pull Request:**
63+
Resolves #1234
7964
```
8065

8166
### Code review

0 commit comments

Comments
 (0)