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.

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

Jump to bottom

Update CONTRIBUTING.md #359

Closed
Jiaweihu08 opened this issue Jul 25, 2024 · 2 comments
Closed

Update CONTRIBUTING.md #359

Jiaweihu08 opened this issue Jul 25, 2024 · 2 comments
Assignees
@Jiaweihu08
Labels
type: documentation Improvements or additions to documentation

Comments

@Jiaweihu08
Copy link
Member

Update CONTRIBUTING.md with more detailed PR guidelines.

To open and merge PRs, the following is to be respected:

  1. Always open an issue for the PR you're working with as much detail as possible
  2. Every PR should have an issue that it is trying to address, ideally one
  3. The title of the PR should follow the schema: Issue <issue-number>: <PR-title>
  4. Ideally, there should be at least two reviewers per PR
  5. The author of the PR never gets to merge the PR; a PR can only be merged by a reviewer
  6. Do a Squash and merge instead of merge, again, by a reviewer
@Jiaweihu08 Jiaweihu08 added the type: bug Something isn't working label Jul 25, 2024
@Jiaweihu08 Jiaweihu08 self-assigned this Jul 25, 2024
@osopardo1 osopardo1 added type: documentation Improvements or additions to documentation and removed type: bug Something isn't working labels Jul 25, 2024
@osopardo1
Copy link
Member

osopardo1 commented Jul 25, 2024 •
edited
Loading

Aaaaaah I forget to add as well that every PR should be linked to an issue (I know is implicit in the steps, but ........)

@osopardo1 osopardo1 mentioned this issue Aug 1, 2024
Merged
6 tasks
@osopardo1
Copy link
Member

Merged on #376

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Jiaweihu08 Jiaweihu08

Labels
type: documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@osopardo1 @Jiaweihu08