Skip to content

docs/setup_new_repo: add some staging guidelines #153

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions docs/setup_new_repo.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,3 +101,27 @@ Below you can see a configuration example:
- Enable "Build pull requests from third-party forked repositories"
- Update commit statuses -> Show blocked builds in GitHub as -> Pending
- Don't forget to click on "Save GitHub Settings"

### Staging workspace

Sometimes a repository might find it easier to bring in new code by
use of a staging area. This can allow the same workflow for reviewing
and discussion of the code without having to meet all the requirements
of the production crates. A staging area should not become permanent
dumping ground, eventually all code should either be moved into
production or removed from the repository.

The staging area should have its own README.md describing the contents
and what criteria need to be met for code to be included.

Building staging code should be an explicit operation, the default
`cargo build` should only build production crates.

While enabling CI for staging is encouraged so that tests can be
developed it should be split from the production testing. Code
proposed for staging should still not fail any part of CI but there
might be acceptable exceptions to DCO and commit format requirements
to allow the importing of messy early history as is. The staging area
may choose to relax the requirements on keeping code coverage on the
understanding code will eventually have to meet those requirements to
be promoted to production.