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

Update contributing guidelines especially around PRs #52

Open
joe94 opened this issue Apr 30, 2020 · 0 comments
Open

Update contributing guidelines especially around PRs #52

joe94 opened this issue Apr 30, 2020 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@joe94
Copy link
Member

joe94 commented Apr 30, 2020

I'm not quite sure how stable our current PR guidelines will stay around what needs to be done to document changes, make releases, etc. But today, we just ask for the changelog.md file to be updated with the following guidelines:

  • (Contributors should consult maintainers before doing this) Add a version section in the changelog file and leave the unreleased section empty if a new version release is to be made. Example: 96545c8

  • If no release needs to be made immediately, simply add a change entry with the link to the PR following changelog guidelines when possible https://keepachangelog.com/en/1.0.0/#how

@joe94 joe94 added documentation Improvements or additions to documentation enhancement New feature or request labels Apr 30, 2020
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
None yet
Development

No branches or pull requests

1 participant