1
0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-28 23:29:45 +01:00
Commit Graph

28 Commits

Author SHA1 Message Date
LukeTheEngineer
63020d1cf2
doc: fix spelling in CONTRIBUTING.md 2024-04-25 11:03:33 +02:00
Oleg Hahm
dbe4d1e681 Contributing: remove broken link to wiki 2023-12-13 12:24:28 +01:00
faae649841
CONTRIBUTING: Remove Freenode reference 2021-06-18 11:11:27 +02:00
a7acf5ee6e
CONTRIBUTING: remove mailing list mentions 2021-05-12 11:41:21 +02:00
Martine Lenders
5725d707d6
CONTRIBUTING.md: add link to forum 2020-12-09 17:24:05 +01:00
Silke Hofstra
00e7fae25b CONTRIBUTING: move 'general tips' under 'contributing code'
The general tips all apply to code contributions. As such,
move them to the right section.
2020-10-20 20:18:14 +02:00
Silke Hofstra
7e57cf2c8f CONTRIBUTING: add --no-backup to uncrustify 2020-10-20 20:18:14 +02:00
Silke Hofstra
ef92773f99 CONTRIBUTING: change code block style
Change the code blocks to triple-backtick (` ``` `) style in order
to 1) provide a consistent indent and 2) enable syntax highlighting.
2020-10-20 20:18:14 +02:00
Silke Hofstra
a34cba3307 CONTRIBUTING: add example commit
Add an example commit to the *commit conventions* section.
Refer to this in the pull request steps.
2020-10-20 20:09:39 +02:00
Silke Hofstra
1cadc95142 CONTRIBUTING: move the 'writing documentation' section
Because the *working with git* section is quite long, it obscures the
*writing documentation* section. Move it to before the *working with
git* section.
2020-10-20 20:09:38 +02:00
Silke Hofstra
16bee2046a CONTRIBUTING: reorganize 'contributing code' and 'pull request'
Having two lists that need to be read thouroughly for pull requests is
unclear. Clean this up by:

- Splitting the *pull request* steps into *coding conventions*,
  *commit conventions*, and *pull requests*

- Completing the contribution steps with references to those sections.

- Reordering all steps to any contributor will encounter them in order.

- Rename and promote 'Git usage', to a 'Working with Git' section.
  This is then referred to at the start of the document and in
  the contribution steps.
2020-10-20 20:09:02 +02:00
Silke Hofstra
1e9ba0d0cb CONTRIBUTING: remove 'feature request' and 'bug reports' sections
These have fairly clear templates in the GitHub interface.
Duplicating that here servers no purpose.
2020-10-20 20:06:41 +02:00
Silke Hofstra
456ae110ed CONTRIBUTING: replace 'help wanted' by 'contributing code'
The naming of the 'help wanted' section is unclear, and unhelpful.
Additionally, most of the items listed in it are not actually part of
the contribution process:

- While *Documentation* is welcome, it is not helpful to document the
  kinds in the contributing document. The contributing document should
  document *how*, not *what*.

- The *Issues* section is out of place: I doubt anyone will look at the
  *contributing guidelines* to find out how to open an issue.
  The content is also pretty self-explanatory.

- What's left is only 'Contributing Code', so promote it!
2020-10-03 14:48:40 +02:00
Silke Hofstra
7a9aa7306d CONTRIBUTING: link to both IRC and Matrix
Link to both the IRC and Matrix end of the chat, as both are used.
2020-10-03 14:48:16 +02:00
Martine Lenders
22db0d9ed4
Merge pull request #12786 from miri64/contributing/enh/wiki+tips
CONTRIBUTING.md: migrate parts of wiki and add general tips
2020-01-16 15:40:00 +01:00
Martine S. Lenders
7aae27de03
CONTRIBUTING.md: Add help for resolving a pull request 2020-01-09 14:56:56 +01:00
Martine S. Lenders
81dbab193e
CONTRIBUTING.md: Add "General Tips" section 2020-01-09 14:56:56 +01:00
jasdeepgill
ad192d78ca
CONTRIBUTING.md: minor readability fixes
General fixes throughout documentation. Made sentence in bug reports section easier to understand.
2019-11-25 07:54:21 +01:00
Martine S. Lenders
e4556f8f35
CONTRIBUTING.md: Add "Getting Started" section 2019-11-22 17:49:51 +01:00
Martine S. Lenders
535950b358
CONTRIBUTING.md: update "Help wanted" section for rest of the file 2019-11-22 17:49:51 +01:00
Martine S. Lenders
4ff77ffc89
CONTRIBUTING.md: copy "Help Wanted" section over from Wiki page
Source: 8d2a6c8a0c (help-wanted)
2019-11-22 17:49:50 +01:00
4c86288ea6 CONTRIBUTING.md: hint to also search closed PRs for previous work 2019-11-21 12:33:35 +01:00
Marian Buschsieweke
0d542a8442
Updated references to coding conventions
Updated the link to the coding conventions in CONTRIBUTING.md and MAINTAINING.md
to no longer point to the wiki, but to CODING_CONVENTIONS.md in the RIOT
repository.
2019-10-25 16:00:21 +02:00
747ebb81c6
CONTRIBUTING: update print toolchain versions command 2019-05-24 17:14:06 +02:00
24744f065b CONTRIBUTING: complete rewrite 2018-10-05 16:58:54 +02:00
Martine Lenders
0551e5c0bc
doc: Add link to code of conduct to contribution guidelines 2017-12-08 12:49:37 +01:00
Ludwig Ortmann
61f405edaa Update CONTRIBUTING.md
Add comment about labels, hint at Development Procedures.
2014-07-11 09:20:58 +02:00
Christian Mehlis
8adf38137d github: added CONTRIBUTING.md 2014-05-15 11:38:35 +02:00