Skip to content
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.

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

WIP docs: Update contribution guidelines #132

Open
wants to merge 3 commits into
base: dev
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
32 changes: 32 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
<!--
Thank you for contributing to Senchabot! 🍵

Before opening this PR please make sure you've read the contribution guideline.

Describe why this Pull Request needs to be merged. What bug have you fixed? What feature have you added? Why is it important?

If you are fixing a specific issue, include "Fixes #ISSUE" (replace with the issue number, remove the quotes) and the issue will be linked to this PR.

-->

**This PR Closes:**

<!-- If there's an existing issue for your change, please link to it below.-->

A clear and concise description of which issue this PR closes. (You can tag issues by writing `#issuenum`) [REPLACE ME]

**What's being changed in this PR (if available, include any code snippets, screenshots, or gifs)**

<!-- Let us know what you are changing. Share anything that could provide the most context. -->

A clear and concise description of what's being changed. [REPLACE ME]

---

### Checklist

Before submitting the PR make sure the following are checked:

* [ ] I've checked [contribution guide](../../CONTRIBUTING.md)
* [ ] I've created new branch in my fork for this PR.
* [ ] For content changes, I have completed the [self-review checklist](self_review.md).
14 changes: 14 additions & 0 deletions .github/self_review.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
## Self review

You should always review your own PR first.

For changes, make sure that you:

- [ ] Confirm the changes you made adheres to [contribution guide](../../CONTRIBUTING.md).
Copy link
Member

Choose a reason for hiding this comment

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

Is CONTRIBUTING.md file location correct here? When I try to access this file, I get a File not found page.

- [ ] Please be sure you've created a new branch in your fork for this PR.
- [ ] Pull Request should be related to one change. Changes that are unrelated should be opened in separate PRs.
- [ ] Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.
- [ ] Confirm that the changes meet the user experience and goals outlined in the content design plan (if there is one).
- [ ] Review the content for technical accuracy.
- [ ] Copy-edit the changes for grammar, spelling, and syntax errors.
- [ ] If there are any failing checks in your PR, troubleshoot them until they're all passing.
5 changes: 5 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
## Contributing

Contributions are welcome! If you have a feature request or find a bug, please open an issue on GitHub.
If you'd like to contribute code, please fork the repository and submit a pull request.

Expand All @@ -9,6 +10,10 @@ If you'd like to contribute code, please fork the repository and submit a pull r
* Create a new branch for your contribution.

#### Please ensure your pull request adheres to the following guidelines:

* Search previous suggestions before making a new one, as yours may be a duplicate.
* Make an individual pull request for each suggestion.
* Please read <https://www.conventionalcommits.org/en/v1.0.0/>
* Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.

Thanks! 🍵