Skip to content

Commit

Permalink
Add MAINTAINERS.md file
Browse files Browse the repository at this point in the history
The MAINTAINERS.md file list the maintainers of the niche files.
Also mention the MAINTAINERS.md file in the contributing docs.

Closes #281
  • Loading branch information
abelsiqueira committed Oct 2, 2024
1 parent 2b95a78 commit 532a17e
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 2 deletions.
7 changes: 7 additions & 0 deletions MAINTAINERS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Maintainers

Some of the files in Bestie are niche, i.e., they are important for a specific group or organization, but not for the great majority of users.
We add these files to Bestie with the condition of also having a maintainer for that file.
If these files are out of date, please ping the maintainer.

- [.cirrus.yml](template/{% if UseCirrusCI %}.cirrus.yml{% endif %}.jinja): Dominique Orban - @dpo
10 changes: 8 additions & 2 deletions docs/src/90-contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,22 @@ We welcome all kinds of contribution, including, but not limited to code, docume

Be polite and respectful, and follow the code of conduct.

## Bug reports and discussions
## Bug reports, feature requests, and discussions

If you think you found a bug, feel free to open an [issue](https://github.com/abelsiqueira/BestieTemplate.jl/issues).
Focused suggestions and requests can also be opened as issues.
Before opening a pull request, start an issue or a discussion on the topic, please.

### Niche

Some of the files in Bestie are niche, i.e., they are important for a specific group or organization, but not for the great majority of users.
Please check the [MAINTAINERS](https://github.com/abelsiqueira/BestieTemplate.jl/blob/main/MAINTAINERS.md) file for the list of maintainers of the niche files.
If your issue involves one of these files, please ping the maintainer.

## Working on an issue

If you found an issue that interests you, comment on that issue what your plans are.
If the solution to the issue is clear, you can immediately create a pull request (see below).
If the solution to the issue is clear, you can immediately create a pull request.
Otherwise, say what your proposed solution is and wait for a discussion around it.

!!! tip
Expand Down

0 comments on commit 532a17e

Please sign in to comment.