Skip to content

Commit 9170a53

Browse files
docs: extend dataset curation docs
Add information about "Allow edits from maintainers" checkbox
1 parent 6f7d8e7 commit 9170a53

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

docs/dataset-curation-guide.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,16 +34,18 @@ If you already have a dataset for Nextclade v2 and want to upgrade it to Nextcla
3434

3535
We use GitHug pull requests to manage contributions to Nextclade datasets.
3636

37-
In order to add or modify datasets you will need to have a local copy of nextstrain/nextclade_data GitHub repository on your computer, make the desired changes, commit & push the changes to a new git branch, and submit a pull request. The pull request will be reviewed by Nextclade maintainers and considered for inclusion to the Nextclade dataset collection.
37+
In order to add or modify datasets you will need to have a local copy of the GitHub repository [`nextstrain/nextclade_data`](https://github.com/nextstrain/nextclade_data) on your computer, make the desired changes, commit & push the changes to a new git branch, and submit a pull request to [`nextstrain/nextclade_data`](https://github.com/nextstrain/nextclade_data). The pull request will be reviewed by Nextclade maintainers and considered for inclusion to the Nextclade dataset collection.
3838

39-
Make sure you have [git](https://git-scm.com/) installed, have an account on [GitHub](https://github.com) and can pull and push code from GitHub repositories.
39+
Make sure you have [git](https://git-scm.com/) installed, have an account on [GitHub](https://github.com) and can pull and push code from and to GitHub repositories.
4040

41-
[Make a fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) of the [nextstrain/nextclade_data origin repository](https://github.com/nextstrain/nextclade_data) and clone your forked repository:
41+
[Make a fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) of the [nextstrain/nextclade_data upstream repository](https://github.com/nextstrain/nextclade_data) and clone your forked repository:
4242

4343
```bash
44-
git clone git@github.com:<your_github_username>/nextclade
44+
git clone git@github.com:<your_github_username>/nextclade_data
4545
```
4646

47+
Add changes to your forked repository, commit and submit a pull request to the upstream repository `nextstrain/nextclade_data`. When submitting, tick the checkbox ["Allow edits from maintainers"](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork), so that `nextstrain-bot` and project maintainers can contribute back to your pull request branch.
48+
4749
Refer to [GitHub documentation "Contributing to projects"](https://docs.github.com/en/get-started/quickstart/contributing-to-projects) for more details.
4850

4951
> 💡 Make sure you [keep your local code up to date](https://github.com/git-guides/git-pull) with the origin repo, [especially if it's forked](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork).

0 commit comments

Comments
 (0)