playframework / playframework/playframework
Document new stable branch procedure
Open
Nobody has claimed this yet.
topic:documentation
- Dominant language
- Scala
- Stars
- 12.6k
- Forks
- 4k
- Avg merge
- 2d 3h
- Merged PRs (30d)
- 29
Description
(Dual of https://github.com/lagom/lagom/issues/1664)
- when should we and when should we not branch the stable branch?
- how should we coordinate/communicate with existing PRs/contributors?
- change the target whitesource project
- add the branch to templatecontrol (check if there are multiple locations)
- make sure nightly artefacts are published from the new branch
- make sure nightly docs are published from the new branch
- make sure nightly performance tests are run on the new branch
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the linked dual issue and tracing the current stable-branch procedure. Locate the Whitesource project, templatecontrol branch locations, and the configurations for nightly artefacts, docs, and performance tests. Done means the procedure documents when to branch, how to coordinate existing PRs, and how each nightly job uses the new branch.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- scala
- Domain
- build-system, ci-cd, documentation, release
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100