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

Additional repo management recommendations #285

Open
5 tasks
jeffpaul opened this issue May 5, 2021 · 0 comments
Open
5 tasks

Additional repo management recommendations #285

jeffpaul opened this issue May 5, 2021 · 0 comments

Comments

@jeffpaul
Copy link
Collaborator

jeffpaul commented May 5, 2021

Is your enhancement related to a problem? Please describe.
On top of the recommended updates in #282, #283, and #284 I'd recommend the following

  • create a CONTRIBUTING.md file so potential contributors know what is expected from them
  • add Release Instructions to CONTRIBUTING.md so that future maintainers know the process to reliably ship a release on the project
  • add a CHANGELOG.md file specific to GitHub to apply a standard in tracking changes to the project
  • add a CREDITS.md file to acknowledge folks who've contributed to the project
  • standardize the README.md file differently than the readme.txt file as the .MD file is specific to GitHub while the .TXT version is specific to WordPress.org

Describe the solution you'd like
I'm happy to help handle PRs on all the above, but want to get confirmation that those updates are desired before I spend time on them.

Designs

Describe alternatives you've considered

Additional context

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant