Skip to content

Commit be2a878

Browse files
committed
chore: update contribution guidelines and pull request template
### Changed - Enhanced the `CONTRIBUTING.md` file to include instructions for linking issues in the changelog entries. - Streamlined the `.github/PULL_REQUEST_TEMPLATE.md` by removing unnecessary sections and clarifying the checklist items for contributors. ### Added - Included a Contribution Guide link and a reminder for contributors to update the `CHANGELOG.md` under the `[NextRelease]` section in the pull request template.
1 parent 68c6ace commit be2a878

2 files changed

Lines changed: 6 additions & 28 deletions

File tree

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 3 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
<!--
22
Thank you for contributing to AgentDocstringsGenerator!
33
4-
Please provide a clear and concise description of your changes.
54
If your PR is a work in progress, please mark it as a draft.
65
-->
76

@@ -20,34 +19,13 @@ Please check the box that best describes the nature of your change.
2019
- [ ] 🎨 **Style**: Changes that do not affect the meaning of the code (white-space, formatting, etc.).
2120
- [ ]**Revert**: Reverts a previous commit.
2221

23-
---
24-
25-
## Related Issue
26-
27-
<!--
28-
If this PR addresses a specific issue, please link it here.
29-
For example: `Fixes #123` or `Closes #123`.
30-
If there is no related issue, please state that.
31-
-->
32-
33-
- ***
34-
35-
## Description
36-
37-
<!--
38-
Provide a clear and concise summary of the changes.
39-
Explain the "what" and "why" of your contribution.
40-
-->
41-
42-
-
43-
4422
## Checklist
4523

4624
<!--
4725
Go over all the following points, and put an `x` in all the boxes that apply.
4826
-->
4927

50-
- [ ] My code follows the style guidelines of this project.
51-
- [ ] I have performed a self-review of my own code.
28+
- [ ] My changes follows the [Contribution Guide](CONTRIBUTING.md).
29+
- [ ] I have updated `CHANGELOG.md` under the `[NextRelease]` section.
5230
- [ ] New unit tests have been added to cover the changes.
53-
- [ ] Manual testing has been performed
31+
- [ ] Manual testing has been performed to verify the changes.

CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -75,16 +75,16 @@ This project uses a GitFlow-like branching model.
7575

7676
### Updating the Changelog
7777

78-
For every change that affects the user, you must add an entry to the `CHANGELOG.md` file under the `[NextRelease]` section. Follow the format of existing entries.
78+
For every change that affects the user, you must add an entry to the `CHANGELOG.md` file under the `[NextRelease]` section. Follow the format of existing entries. If your pull request resolves an existing issue, please link it in the changelog entry `(fixes #123)` or `(closes #456)`).
7979
8080
Example:
8181
8282
```markdown
8383
## [NextRelease]
8484
85-
### TypeOfChange
85+
### Fixed
8686
87-
- **Your Awesome Feature**: A brief description of what you've added.
87+
- **My Awesome Fix**: A brief description of what you've fixed (fixes #78).
8888
```
8989
9090
## Release Process (for maintainers)

0 commit comments

Comments
 (0)