Skip to content
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

CONTRIBUTING.md getting too big #521

Closed
mfisher87 opened this issue Apr 15, 2024 · 1 comment · Fixed by #533
Closed

CONTRIBUTING.md getting too big #521

mfisher87 opened this issue Apr 15, 2024 · 1 comment · Fixed by #533
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@mfisher87
Copy link
Member

mfisher87 commented Apr 15, 2024

I find the doc a bit overwhelming to traverse to find the thing I'm looking for. I think it could stand to be made in to a category. Perhaps subpages would look like: contributing/development.md (e.g. "Here's how you set up your environment"), contributing/releasing.md (e.g. "Here's how we use semver"), contributing/maintenance.md (e.g. "Here's what maintainers do and how to be come one"), and contributing/explanations.md (e.g. "Here's why we use semver").

@mfisher87 mfisher87 added documentation Improvements or additions to documentation enhancement New feature or request labels Apr 15, 2024
@mfisher87 mfisher87 self-assigned this Apr 19, 2024
@mfisher87 mfisher87 linked a pull request Apr 19, 2024 that will close this issue
@mfisher87
Copy link
Member Author

Resolved in #533

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

1 participant