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

Supplement the CONTRIBUTING.md file with additional guidance regarding the PR section #71

Open
kurosakishigure opened this issue Dec 14, 2024 · 3 comments
Labels
documentation Improvements or additions to documentation

Comments

@kurosakishigure
Copy link
Owner

kurosakishigure commented Dec 14, 2024

Page Link

https://github.com/kurosakishigure/katharsis/blob/canary/.github/CONTRIBUTING.md

What is the documentation issue?

The document currently lacks a clear explanation of the strong alignment required between the content of PRs and their corresponding Issues. Sometimes, PRs may extend beyond the scope of what was originally outlined in the related Issue, introducing out-of-scope changes.

Additionally, if a PR is not of critical importance, we should encourage contributors to share their ideas in the Discussions section instead.

Is there any context that might help us understand?

Include these details in the introductory comments at the beginning of the document for clarity:
Screenshot 2024-12-14 at 10 32 49 AM

@kurosakishigure kurosakishigure added the documentation Improvements or additions to documentation label Dec 14, 2024
@kurosakishigure
Copy link
Owner Author

We also need to remind contributors that if they wish to elevate an idea to an Issue, they should use the "Create issue from discussion" feature to ensure it is properly linked to the corresponding Issue:
Screenshot 2024-12-14 at 10 36 36 AM

@kurosakishigure
Copy link
Owner Author

For the chore type, we have two ideas:

  1. Inform contributors that this is a special type that typically skips the issue stage and goes directly to a PR submission.
  2. Remove the description for this type, as it is primarily used for version bumps at this stage and isn't very relevant to contributors.

Additionally, we might need to clarify that some labels are reserved for bots.

@kurosakishigure
Copy link
Owner Author

We also need to add the purpose and precautions for using the "revert" tag.

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
Projects
None yet
Development

No branches or pull requests

1 participant