Skip to content

Commit

Permalink
docs: improve CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
rickstaa committed Mar 13, 2023
1 parent 4e4f353 commit 6fb624c
Showing 1 changed file with 1 addition and 4 deletions.
5 changes: 1 addition & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,7 @@ Pull requests are the best way to propose changes to the codebase (we use [Githu

## Keep your fork updated

As the [README](README.md) explains, this repository uses GitHub actions to create several derivative databases from the main databases. By default, the [create_db_derivatives.yaml](.github/workflows/create_db_derivatives.yaml) action that makes these derivative databases is disabled on forks. You therefore have to follow the following steps if you want this action to automatically generate the correct derivative databases on your fork:

1. Set the `CREATE_DERIVATIVES` repository variable to `true` in your repository settings (see [the GitHub documentation](https://docs.github.com/en/actions/learn-github-actions/variables#creating-configuration-variables-for-a-repository)).
2. Change the default `GITHUB_TOKEN` permissions to `Read and write permission` (see [the GitHub documentation](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#configuring-the-default-github_token-permissions)).
As the [README](README.md) explains, this repository uses GitHub actions to create several derivative databases from the main databases. By default, the [create_db_derivatives.yaml](.github/workflows/create_db_derivatives.yaml) action is disabled on forks. You, therefore, have to Set the `CREATE_DERIVATIVES` repository variable to `true` in your repository settings (see [the GitHub documentation](https://docs.github.com/en/actions/learn-github-actions/variables#creating-configuration-variables-for-a-repository)) if you want this action to generate the correct derivative databases on your fork automatically

## Report bugs using Github's [issues](https://github.com/sdr-enthusiasts/plane-alert-db/issues)

Expand Down

0 comments on commit 6fb624c

Please sign in to comment.