Skip to content

Commit 5152f6f

Browse files
authored
Update CONTRIBUTING.md
No need to update changelog since we generate it automatically now.
1 parent 6a83eaa commit 5152f6f

File tree

1 file changed

+3
-14
lines changed

1 file changed

+3
-14
lines changed

CONTRIBUTING.md

+3-14
Original file line numberDiff line numberDiff line change
@@ -33,20 +33,9 @@ Unless for very simple and straightforward changes, please open an issue first t
3333

3434
* Unit tests whenever you add a bug fix, new feature, or when you change an existing one.
3535

36-
* All changes relevant to Moq users should be documented in the `CHANGELOG.md`. Please describe your change or bug fix in that file (more specifically under the _Unreleased_ heading at the beginning of it). Phrase the summary in a way that it will be easily understandable and useful to other Moq users.
37-
38-
```diff
39-
# Unreleased
40-
41-
...
42-
43-
#### Fixed
44-
45-
+* <Short explanation of the bug fix> (@<your username>, #<issue or PR number>)
46-
```
47-
48-
Note the inclusion of your user name and a reference to the relevant PR or issue. The former is included to give you credit for your contribution. The latter allows users to trace the history of a change back to the issue where it was first reported.
49-
36+
* Your merged PR title will be included automatically in the changelog of the next release
37+
if labeled as a bug fix, documentation update or feature.
38+
Make sure it's a good short explanation of the bug/feature for that purpose.
5039

5140
**Structuring your PR commits (example):** One good way, but not the only one, of structuring your PR might be to follow a test-first approach:
5241

0 commit comments

Comments
 (0)