-
Notifications
You must be signed in to change notification settings - Fork 67
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
Maintainer's Guide #187
Draft
yandthj
wants to merge
5
commits into
NREL:master
Choose a base branch
from
yandthj:maintainers-guide
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Maintainer's Guide #187
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
# Policy and Procedure | ||
|
||
|
||
## Maintainers | ||
|
||
|Maintainer|Role| | ||
|---|---| | ||
|*Dan Harris|CSC Operations| | ||
|*Kevin Sayers|CSC Applications| | ||
|Chris Chang|CSC Applications| | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove this as well |
||
|Ethan Young|CSC Applications| | ||
|Tim Kaiser|CSC Applications| | ||
|John Leicht|CSC Operations| | ||
|
||
_\* indicates repo admin_ | ||
|
||
## Maintainership | ||
|
||
|
||
## Adding maintainers | ||
|
||
|
||
## Removing maintainers | ||
|
||
|
||
## How are decisions made? | ||
|
||
|
||
## Conflict Resolution |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,71 @@ | ||
# Maintainer Guidelines | ||
|
||
**This guide is for maintainers.** These people have **write | ||
access** to NREL HPC's repository and help merge the contributions of | ||
others. | ||
|
||
If you have something to contribute, please see the [Contributing Guide](CONTRIBUTING.md). | ||
|
||
This is a living document - if you see something out of date or missing, | ||
speak up! | ||
|
||
## What are a maintainer's responsibilities? | ||
|
||
It is every maintainer's responsibility to: | ||
|
||
* Deliver prompt feedback and decisions on pull requests. | ||
* Be available to anyone with questions, bug reports, criticism etc. on the repository. | ||
This includes GitHub issues and pull requests. | ||
|
||
## How are decisions made? | ||
|
||
All decisions affecting this project, big and small, follow the same procedure: | ||
|
||
1. Open a pull request. | ||
Anyone can do this. | ||
2. Discuss the pull request. | ||
Anyone can do this. | ||
3. Review the pull request. | ||
The relevant maintainers do this (see below [Who decides what?](#who-decides-what)). | ||
4. Merge or close the pull request. | ||
The relevant maintainers do this. | ||
|
||
#### I'm a maintainer, should I make pull requests too? | ||
|
||
Yes. Nobody should ever push to the repository directly. All changes should be | ||
made through a pull request. | ||
|
||
### Who decides what? | ||
|
||
Only maintainers are counted towards the required | ||
review. In addition, if a maintainer has created a pull request, they cannot | ||
review it themselves (to ensure equal amounts of review for every pull | ||
request, no matter who wrote it). | ||
|
||
|
||
## Handling Pull Requests | ||
|
||
### Acceptance Criteria: | ||
* The PR complies with the [contribution guidelines](CONTRIBUTING.md) | ||
* The PR targets the appropriate branch | ||
* The content is clear, free of typos, and relevant to NREL HPC users | ||
|
||
### Process for Pull Requests: | ||
* PRs can be merged once they have been approved by at least 1 maintainer. | ||
* Any new PR should be assigned a reviewer within 2 weeks. The reviewer should give a response within one week of assignment. | ||
* As a result of their review, a maintainer can: | ||
1. Request changes in the Pull Request (which blocks merging until the changes are resolved) | ||
3. Approve the Pull Request | ||
4. Propose closing the Pull Request | ||
* Maintainers need to submit the review in Github so that it is clear when the review is complete. | ||
* If the only issues holding up a merge are trivial fixes (typos, syntax, etc.) and the author doesn't respond within 2 weeks to the requested changes or comments, the maintainers can make the necessary changes themselves and proceed with the merge process. | ||
* If the requested changes to a PR don't receive a response from the submitter within 1 month, a maintainer can choose to take over the PR and make necessary changes or it can be closed. | ||
* If a PR is related to an issue, check whether the issue is completely resolved and can be closed. Comment with the PR number when closing the issue. Modify or comment on the issue if it is not entirely resolved. | ||
* A PR can be closed if it does not meet the acceptance criteria or does not receive a response to requested changes within 1 month. To close a PR, bring up a discussion at a Maintainer's meeting to get consensus. | ||
* If closing a PR, leave a comment about why it was closed. | ||
|
||
|
||
|
||
|
||
|
||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We probably need to change this.