Skip to content

Commit

Permalink
docs: add links to CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
rickstaa committed Mar 10, 2023
1 parent a3aafd1 commit 389a088
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,11 @@

We love your input! 🚀 We want to make contributing to this project as easy and transparent as possible, whether it's:

- Reporting a bug.
- [Reporting a bug](https://github.com/sdr-enthusiasts/plane-alert-db/issues/new?assignees=&labels=bug&template=bug_report.yml).
- Discussing the current state of the code.
- Submitting a fix.
- Proposing new features.
- [Submitting a fix](https://github.com/sdr-enthusiasts/plane-alert-db/compare).
- [Proposing new features](https://github.com/sdr-enthusiasts/plane-alert-db/issues/new?assignees=&labels=enhancement&template=feature_request.yml).
- [Reviewing pull requests](https://github.com/sdr-enthusiasts/plane-alert-db/pulls).
- Becoming a maintainer.

## We Develop with Github
Expand All @@ -31,7 +32,7 @@ As the [README](README.md) explains, this repository uses GitHub actions to crea
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)).

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

[This is an example](http:https://stackoverflow.com/q/12488905/180626) of a bug report, and I think it's a good model. Here's [another example from Craig Hockenberry](http:https://www.openradar.me/11905408), an app developer greatly respected in the community.

Expand Down

0 comments on commit 389a088

Please sign in to comment.