Skip to content

Commit 87e74f9

Browse files
committed
Add contribution workflow details
1 parent eda5384 commit 87e74f9

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

contributing.qmd

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,18 @@ We encourage contributions to this guide. The guide's goal is to provide documen
1010

1111
If you wish to preview the site locally, install [quarto](https://quarto.org/). You will also need to be familiar with [quarto markdown](https://quarto.org/docs/authoring/markdown-basics.html).
1212

13+
## Contribution Workflow
14+
15+
Due to previews only working from branches within the repository and not external forks (see: [#74](https://github.com/cloudnativegeo/cloud-optimized-geospatial-formats-guide/issues/74)), all PRs should target staging. More specifically, the contribution workflow follows these steps:
16+
17+
1. PR is made with `staging` as target.
18+
19+
2. Maintainer will merge the PR to staging and then open a PR to main (build preview will run).
20+
21+
3. Maintainers merge to main which triggers the production deployment.
22+
23+
The process is not ideal, and we are open to suggestions on how to improve upon it. The main constraint is the [`pr-preview-action`](https://github.com/rossjrw/pr-preview-action) not supporting previews on external contributions.
24+
1325
## Communication Channels
1426

1527
Discussions can occur in [GitHub Discussions](https://github.com/cloudnativegeo/cloud-optimized-geospatial-formats-guide/discussions) and issues can be raised at [GitHub Issues](https://github.com/cloudnativegeo/cloud-optimized-geospatial-formats-guide/issues).

0 commit comments

Comments
 (0)