Skip to content

Commit

Permalink
Adding best practices to a few md files
Browse files Browse the repository at this point in the history
Signed-off-by: Jonah Kowall <[email protected]>
  • Loading branch information
jkowall committed Sep 28, 2024
1 parent df9cbc7 commit 053bea0
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions MAINTAINERS.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,22 @@

This document contains a list of maintainers in this repo. See [opensearch-project/.github/RESPONSIBILITIES.md](https://github.com/opensearch-project/.github/blob/main/RESPONSIBILITIES.md#maintainer-responsibilities) that explains what the role of maintainer means, what maintainers do in this and other repos, and how they should be doing it. If you're interested in contributing, and becoming a maintainer, see [CONTRIBUTING](CONTRIBUTING.md).

## Merging PRs
OpenSearch pull requests are merged after there is approval from at least 1 maintainer.

Each PR should have:

* A descriptive title, known as ["commit message"][good-commit-msg]. In summary:
* Limit the title to 50 characters
* Capitalize the title
* Do not end the title with a period
* Use the imperative mood in the title
* A description of the problem it is solving. It could be simply a reference to the corresponding issue, e.g. `Resolves #123`.
* A summary of changes made to solve the problem. Explain _what_ and _why_ instead of _how_.

Merge the PR by using "Squash and merge" option on Github. Avoid creating merge commits.
After the merge make sure referenced issues were closed.

## Current Maintainers

| Maintainer | GitHub ID | Affiliation |
Expand Down

0 comments on commit 053bea0

Please sign in to comment.