Skip to content

Improve and split the contributors' guide #361

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
Draft
wants to merge 6 commits into
base: v0.x.x
Choose a base branch
from
Draft

Improve and split the contributors' guide #361

wants to merge 6 commits into from

Conversation

llucax
Copy link
Contributor

@llucax llucax commented Feb 25, 2025 •
edited
Loading

This PR adds a development and maintainers' guide and rewrites the contributing guide so it is focused on contributions.

Fixes #266.

@github-actions github-actions bot added the part:template Affects the cookiecutter template files label Feb 25, 2025
@llucax
Copy link
Contributor Author

llucax commented Feb 25, 2025 •
edited
Loading

TODO:

  • Now the README.md has a broken link to CONTRIBUTING.md when it is included from docs/index.md. We probably need to address it by splitting the README up, like suggested in Reuse parts of the README in the docs #279.
  • Add a link to the development guide in the README.md when the above is fixed.
  • Update the project files themselves besides the templates.
  • Write a migration for this.
  • Maybe consider putting these files in a common repo, but might be challenging to find a place for them and how to include them in projects.
  • Check the suggestions in Improve and split CONTRIBUTING.md #266 more in detail, this was done without looking at that issue, only looking at the discussion in Improve documentation on how to install from sources #246.

@llucax llucax added part:docs Affects the documentation type:enhancement New feature or enhancement visitble to users labels Feb 25, 2025
@llucax llucax self-assigned this Feb 25, 2025
@llucax llucax force-pushed the contributing branch 2 times, most recently from ed9dc09 to 5307e04 Compare February 27, 2025 11:00
llucax added 6 commits March 26, 2025 12:54
@llucax
Add callouts markdown extension
cc37d5c 
This extension allows using the "GitHub alert"[1] syntax for
admonitions. This is used to write admonitions in a way that are nicely
rendered by GitHub too.

[1] https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts

Signed-off-by: Leandro Lucarella <[email protected]>
@llucax
Add a new introduction to developing the project
8c59c41 
This document extract the parts relevant to development from the
CONTRIBUTING guide and expands it to make it more useful as an
introduction to new developers and people wanting to hack the project.

Signed-off-by: Leandro Lucarella <[email protected]>
@llucax
Add a new maintainer' guide
4be0887 
This document extract the parts relevant to maintenance of the project
from the CONTRIBUTING guide to have a central place where maintainers
can learn and document maintenance processes.

Signed-off-by: Leandro Lucarella <[email protected]>
@llucax
Update the contributing guide to be focused on contribution
0f51f2d 
The contributing guide was mainly a development and maintainer' guide,
not really saying much about how to contribute itself.

Signed-off-by: Leandro Lucarella <[email protected]>
@llucax
Add a new Community documentation section
b140461 
This section is the home for documents on how to contribute and maintain
the project.

Signed-off-by: Leandro Lucarella <[email protected]>
@llucax
Remove the old CONTRIBUTING section
ef91f18 
Now the contributing guide is one document in the new community section.

Signed-off-by: Leandro Lucarella <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

Copilot code review Copilot Awaiting requested review from Copilot Copilot will automatically review once the pull request is marked ready for review

At least 1 approving review is required to merge this pull request.

Assignees

@llucax llucax

Labels
part:docs Affects the documentation part:template Affects the cookiecutter template files type:enhancement New feature or enhancement visitble to users
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Improve and split CONTRIBUTING.md
1 participant
@llucax