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

docs: rewrite CONTRIBUTING.md #1098

Merged
merged 3 commits into from Sep 5, 2023
Merged

docs: rewrite CONTRIBUTING.md #1098

merged 3 commits into from Sep 5, 2023

Conversation

shiftinv
Copy link
Member

@shiftinv shiftinv commented Aug 28, 2023

Summary

A general overhaul of the entire contribution guide, hopefully making it easier to follow and understand. Also includes the documentation side of #196, i.e. outlining the commit/PR naming convention.

This removes the detailed example which, while insightful, was way too lengthy for new contributors. We could maybe re-add it on a separate page in the future, but for now it's too much for this guide.

preview: https://github.com/DisnakeDev/disnake/blob/docs/contributing-once-more/CONTRIBUTING.md

Checklist

  • If code changes were made, then they have been tested
    • I have updated the documentation to reflect the changes
    • I have formatted the code properly by running pdm lint
    • I have type-checked the code by running pdm pyright
  • This PR fixes an issue
  • This PR adds something new (e.g. new method or parameters)
  • This PR is a breaking change (e.g. methods or parameters removed/renamed)
  • This PR is not a code change (e.g. documentation, README, ...)

@shiftinv shiftinv added t: documentation Improvements or additions to documentation/examples s: needs review Issue/PR is awaiting reviews t: meta Changes to the project itself (CI, configs, etc.) labels Aug 28, 2023
@shiftinv shiftinv added this to the disnake v2.10 milestone Aug 28, 2023
@shiftinv shiftinv merged commit 6689bb6 into master Sep 5, 2023
23 checks passed
@shiftinv shiftinv deleted the docs/contributing-once-more branch September 5, 2023 15:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
s: needs review Issue/PR is awaiting reviews t: documentation Improvements or additions to documentation/examples t: meta Changes to the project itself (CI, configs, etc.)
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

None yet

1 participant