Skip to content

Commit

Permalink
create maintainer_guidelines template (#66)
Browse files Browse the repository at this point in the history
  • Loading branch information
Jayita10 authored Sep 26, 2021
1 parent a9ef2da commit 5a60016
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions MAINTAINER_GUIDELINES.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
## **Guidelines**

Make sure contributors are respecting the [Contribution Guidelines](https://github.com/anitab-org/anitab-org.github.io/blob/develop/CONTRIBUTING.md). If they don't let them know about it: what is missing, what was disrespected?

### Code Review

* When possible get a second opinion before merging.
* Make sure the PR has a link to the issue.
* If you can, let them know why your change request makes sense.
* (nice to have) If you have time, thank them for contributing to the project.
* Make sure that, if the PR changes actual code, to properly test it or wait for someone to confirm the behavior

### Merging PRs
**TL;DR:**

1. Select "Squash and Merge".
2. Edit commit if necessary to follow our style guide and leave the PR id in the message.

**Long version:**

About merging pull requests (PRs), to keep the project commit history clean, it's important to have all commits from a PR to be squashed when merging. For this you may have to select "Squash and Merge" option:


<img src="https://user-images.githubusercontent.com/11148726/76369025-06146e80-632a-11ea-922a-c28073539125.png" width="80%" alt= "Squash and Merge on GitHub" />

If the commit does not follow our [Commit Message Style Guide](https://github.com/anitab-org/anitab-org.github.io/wiki/Commit-Message-Style-Guide), make sure to ask the contributor to fix it or you can fix it when merging.

<img src="https://user-images.githubusercontent.com/11148726/76369362-33155100-632b-11ea-90d1-879dbecfb059.png" width="80%" alt= "Edit Commit when Merging" />

Make sure to always leave the PR identifier, so that we can traceback a commit to a specific PR.

0 comments on commit 5a60016

Please sign in to comment.