diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 936e297813b..aaa89633e6b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,14 +1,5 @@ # Contributing to Scylla Operator -## Prerequisites - -To develop Scylla Operator, ensure your environment has the following items configured: - -1. [Go](https://golang.org/dl) - * Check `go.mod` for minimal version requirement. -2. Git client -3. GitHub account - ## Initial Setup ### Fork the repository @@ -58,17 +49,10 @@ To maintain a clean commit history, aim for a minimal number of logical commits. 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." . Every release note is based on these first lines, so make them concise yet informative. -If you have more to say about the change, then enter a blank line and carry on the description. -Remember to say why the change was needed - the commit itself shows what was changed. +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. +If your PR fixes an issue, include "Fixes #1234" in the description, replacing "1234" with the issue number. -Writing more is better than less. Comparing the behavior before the change to that after the change is beneficial. -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. - -If the change fixes an issue, then write Fixes #1234 in the PR description. - -Here is an example of a good commit message and PR title/description: ``` - Add new XYZ field to ScyllaCluster CRD. The new field allows for configuration of ZYX feature of ScyllaDB.