From caca7adb18bf6dd886d8951d36667721c39a4e48 Mon Sep 17 00:00:00 2001 From: Abel Soares Siqueira Date: Wed, 2 Oct 2024 10:54:15 +0200 Subject: [PATCH] Add MAINTAINERS.md file The MAINTAINERS.md file list the maintainers of the niche files. Also mention the MAINTAINERS.md file in the contributing docs. Add @dpo as maintainer of the Cirrus CI configuration file. Closes #281 --- MAINTAINERS.md | 7 +++++++ docs/src/90-contributing.md | 10 ++++++++-- 2 files changed, 15 insertions(+), 2 deletions(-) create mode 100644 MAINTAINERS.md diff --git a/MAINTAINERS.md b/MAINTAINERS.md new file mode 100644 index 00000000..86dfdc1c --- /dev/null +++ b/MAINTAINERS.md @@ -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](https://github.com/dpo) diff --git a/docs/src/90-contributing.md b/docs/src/90-contributing.md index 7bdc2218..9346a175 100644 --- a/docs/src/90-contributing.md +++ b/docs/src/90-contributing.md @@ -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