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

Add contribution advice to docs about PRs #250

Open
h1divp opened this issue Sep 6, 2024 · 1 comment
Open

Add contribution advice to docs about PRs #250

h1divp opened this issue Sep 6, 2024 · 1 comment
Assignees
Labels
Documentation Improvements or additions to documentation

Comments

@h1divp
Copy link
Collaborator

h1divp commented Sep 6, 2024

For newer members who join this project, adding some advice for what to include in PRs (like saying "this PR fixes issues #0000") and other general points for what a comment should have could be added. Referring people to this page/section before contributing could potentially make future PRs have a lot more quality. I would add things like:

  • Note what issue your PR fixes in the description
  • Describe your changes, what has been tested (hopefully all new changes), what might need testing, etc
  • How to make a good title (also would go for commits)

I know some older folks who have given good advice about what PRs and issues should contain. I think it should certainly be relayed to newer folk who are getting their feet wet with contributing to a project. If you have good advice in this area please shoot me a DM on discord.

@h1divp h1divp added the Documentation Improvements or additions to documentation label Sep 6, 2024
@AlexanderWangY
Copy link
Collaborator

I gotchu phoenix

@AlexanderWangY AlexanderWangY self-assigned this Sep 6, 2024
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

2 participants