Skip to content

Commit

Permalink
[docs] Use Discussions instead of Issues
Browse files Browse the repository at this point in the history
  • Loading branch information
salkinium committed Sep 30, 2021
1 parent b728a0f commit dad9799
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 4 deletions.
8 changes: 5 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@

We love receiving pull requests. We use them ourselves for reviewing new features
and fixing issues in modm. If you want to contribute, but don't exactly know what
or how, have a look at the [issues we tagged with "help wanted"][help_wanted].
or how, have a look at the [issues we tagged with "help wanted"][help_wanted] or
the [threads tagged with "💡 Ideas"][ideas].

To start contributing, please fork modm and then start a new branch on top of
the `develop` branch. We prefer to fast-forward merges, instead of creating a
Expand Down Expand Up @@ -36,13 +37,14 @@ The dedicated maintainers of modm are [@salkinium](https://github.com/salkinium)
and [@rleh](https://github.com/rleh) and you can always ping them.

If you want to add a new platform, or other significant functionality, we
[ask you to discuss that in an issue first][issues]. We are very open to new
helping hands, but all of this is still fairly complicated and we want to
[ask you to discuss that in a thread first][ideas]. We are very open to
new helping hands, but all of this is still fairly complicated and we want to
provide you with tips and additional explanations along the way.

Communication is cheap, implementation is expensive and we don't want to
frustrate you.

[issues]: https://github.com/modm-io/modm/issues
[pulls]: https://github.com/modm-io/modm/pulls
[ideas]: https://github.com/modm-io/modm/discussions/categories/ideas
[help_wanted]: https://github.com/modm-io/modm/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted+🛠%22
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,12 @@ process that you can fine-tune to your needs.
- [API reference is available here][api-docs].
- [We do quarterly releases][releases] with a [curated changelog][changelog].

This project also has a [technical blog][blog] to document larger design concepts.
This project also has a [forum for discussions][discussions] and a
[technical blog][blog] to document larger design concepts.

- You found a bug? [Open up an issue, we don't bite][issues].
- You have a question? [We probably have an answer][questions].
- You require a feature? [Write it down to get things rolling][ideas].
- You want to contribute? [Read the contribution guidelines][contrib] and [open a pull request][prs].

modm is optimized for the harsh requirements of the [Eurobot competition][eurobot],
Expand Down Expand Up @@ -752,6 +755,9 @@ and [many more contributors][contributors].
[install]: https://modm.io/guide/installation
[issues]: https://github.com/modm-io/modm/issues
[prs]: https://github.com/modm-io/modm/pulls
[discussions]: https://github.com/modm-io/modm/discussions
[questions]: https://github.com/modm-io/modm/discussions/categories/q-a
[ideas]: https://github.com/modm-io/modm/discussions/categories/ideas
[testing]: https://github.com/modm-io/modm/tree/develop/test/README.md
[api-docs]: https://docs.modm.io/

Expand Down

0 comments on commit dad9799

Please sign in to comment.