Skip to content

Commit 6be66fd

Browse files
Subham-KRLXjbamptongemini-code-assist[bot]
authored
docs: enhance pre-commit setup instructions for contributors (brisbanesocialchess#286)
* docs: enhance pre-commit setup instructions for contributors * docs: finalize contributing guide with clear and consistent instructions * docs: update pull request creation instructions for clarity and simplicity * docs: minor update to Community Support section to trigger PR button * Update CONTRIBUTING.md Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> * Update CONTRIBUTING.md Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> * Update CONTRIBUTING.md Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> * Update CONTRIBUTING.md Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> * Update CONTRIBUTING.md Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> * Update CONTRIBUTING.md Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> * Update CONTRIBUTING.md Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> * Update CONTRIBUTING.md Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> * Update CONTRIBUTING.md Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> --------- Co-authored-by: John Bampton <jbampton@users.noreply.github.com> Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
1 parent dd3e393 commit 6be66fd

File tree

1 file changed

+24
-11
lines changed

1 file changed

+24
-11
lines changed

CONTRIBUTING.md

Lines changed: 24 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -112,31 +112,37 @@ Our configuration is already in the repo: [dprint.json](./dprint.json)
112112

113113
#### 🧪 Setting Up pre-commit
114114

115-
Used to enforce newline at end of files and OS-specific line endings.
115+
We use [pre-commit](https://pre-commit.com/) to automatically check your code for common issues, like missing end-of-file newlines and inconsistent line endings. This keeps our project clean and easy for everyone to work on.
116116

117-
**Install (requires Python):**
117+
**How to install (requires Python):**
118118

119119
```bash
120-
pip install pre-commit
120+
python -m pip install --user pre-commit
121121
```
122122

123-
**Activate pre-commit hooks:**
123+
**Set up pre-commit hooks for this project:**
124124

125125
```bash
126126
pre-commit install
127127
```
128128

129-
**Run manually (optional):**
129+
This will make pre-commit run its checks every time you make a commit.
130+
**Running checks manually (optional):**
130131

131132
```bash
132133
pre-commit run --all-files
133134
```
134135

136+
This command runs all configured pre-commit hooks against all files in the repository.
137+
For more info, visit the [pre-commit website](https://pre-commit.com/).
138+
135139
---
136140

137141
### 5. 📝 Commit Changes
138142

139-
Use descriptive commit messages that clearly state the purpose of your changes.
143+
Use meaningful and clear commit messages that describe the purpose of your changes. This helps maintain a clean and understandable project history.
144+
145+
**Example of staging and committing changes:**
140146

141147
```bash
142148
git add .
@@ -145,22 +151,29 @@ git commit -m "Add feature: description of feature"
145151

146152
### 6. ⬆️ Push Changes
147153

154+
Push your local branch to your remote fork. Replace `your-branch-name` with the name of your current branch.
155+
148156
```bash
149157
git push origin add-new-feature
150158
```
151159

160+
This makes your changes available for review and merging via a Pull Request.
161+
152162
### 7. 🔄 Create a Pull Request
153163

154164
- Go to your forked repository on GitHub.
155-
- Click **"Compare & pull request"**.
156-
- Add a title and description (e.g., "Fixes #102").
157-
- Click **"Create pull request"**.
165+
- Click the **"Compare & pull request"** button near the top of the page.
166+
- Make sure your changes look correct and you are merging into the right branch.
167+
- Write a clear and simple title describing your changes.
168+
- Add a short description explaining what you changed and why. If it fixes an issue, mention it like this: `Fixes #issue-number`.
169+
- Click **"Create pull request"** to submit your contribution.
170+
- Watch for feedback on your Pull Request and respond to any comments.
158171

159172
---
160173

161174
## Community Support
162175

163176
If you need help or have questions:
164177

165-
- Join Discussions: Participate in discussions.
166-
- Contact Maintainers: Reach out to project maintainers if needed.
178+
- Join Discussions: Participate in ongoing discussions with the community.
179+
- Contact Maintainers: Reach out to project maintainers if you need direct assistance.

0 commit comments

Comments
 (0)