Skip to content

docs: Add a pull request template #142

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

docs: Add a pull request template #142

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
## What does this change do?
<!-- A brief summary of the change -->


<!-- Why is this change needed? For example, what is the current behaviour, compared to the new behavior. -->


## How was this tested?
<!-- How did you verify the change works as expected? How can reviewers repeat those tests? -->


## Other details
<!-- If the implementation is complex, add details here. Also include any other related issues, docs, or discussions -->


<!--## Is there a breaking change introduced? -->
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are we wanting to leave this (and the next one) here, but commented out? Is this in case we ever want to add them? Or for the user to uncomment if/when they need these sections?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah I'm not super happy with the one I wrote here in general now I've tried it. I spent a bit too long on it so I'll put this into draft and revisit another day I think.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fair enough. Did you ask multiple AIs to see which one pukes out the best thing? :)

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cheers for the approve - I'm glad that the idea is approved anyway! I'll probably change it a bit and let you know for a re look.

<!-- Is there a breaking change in this PR? Will existing users have to modify anything in order to keep running? -->


<!--
## Checklist
- [ ] The PR title and commit messages includes the type of change described in [the contributing guidelines](https://github.com/CogStack/cogstack-nlp/blob/main/CONTRIBUTING.md)
- [ ] The relevant checks have all passed
- [ ] Tests added/updated if applicable
-->
6 changes: 2 additions & 4 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,10 +122,8 @@ An example PR title could be
feat(medcat-service): Create API for healthchecks for container monitoring
```

#### Pull Request Bodies
We haven't put a formal template in for pull requests yet.

Though the structure isn’t enforced, a good PR description helps reviewers and future maintainers.
#### Pull Request Description
A good PR description helps reviewers and future maintainers.

Consider including things such as:

Expand Down