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 release documentation #131

Closed
JustinyAhin opened this issue Jan 26, 2022 · 2 comments · Fixed by #138
Closed

Add release documentation #131

JustinyAhin opened this issue Jan 26, 2022 · 2 comments · Fixed by #138
Assignees
Labels
Infrastructure Issues for the overall performance plugin infrastructure [Type] Documentation Documentation to be added or enhanced
Milestone

Comments

@JustinyAhin
Copy link
Member

It'll benefit all the contributors to have some documentation about how we release the plugin (GitHub releases and deployment to w.org).

This will include any pre-release checks, scripts to run (linting, formatting?) before the releases, and any other useful information.

@JustinyAhin JustinyAhin added the [Type] Documentation Documentation to be added or enhanced label Jan 26, 2022
@JustinyAhin JustinyAhin added the Infrastructure Issues for the overall performance plugin infrastructure label Jan 26, 2022
@jeffpaul
Copy link
Member

100% in favor of this, would recommend its either part of https://github.com/WordPress/performance/blob/trunk/CONTRIBUTING.md as a Release Instructions section or if its rather lengthy then could be in its own RELEASING.md file in the repo.

@felixarntz felixarntz mentioned this issue Jan 28, 2022
5 tasks
@felixarntz
Copy link
Member

@jeffpaul We have a docs directory intended for most documentation, so I suggest we put the release documentation in there. Potentially it could be linked in the CONTRIBUTING.md file - although I'm personally not sure that's necessary, given that releasing is not exactly the most relevant task for people who want to start contributing. But we should definitely have an easy-to-reach entry point where it is linked.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Infrastructure Issues for the overall performance plugin infrastructure [Type] Documentation Documentation to be added or enhanced
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants