amfoss / amfoss/root

Move (and improve) contributing information from README.md to CONTRIBUTING.md

Offen
#136 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
documentation good first issue
Vorherrschende Sprache
Rust
Sterne
4
Forks
23
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

We have a small section in `README.md` about contributing that should be moved into it's own file. Additionally, the content in that section needs the following improvements:

- Instead of detailing steps (add title, description etc) to open PRs/issues, simply encourage (and thank) people to add issues and open PRs. Then provide a short and practical list of guidelines that might be useful for beginner contributors such as "check existing issues first before opening a new one". The idea is to avoid having arbitrary style guidelines (like having description, steps to reproduce, expected behaviour, alternatives etc) and be more practical.
- Coding standards seems like a useless section. People who know won't need to be told and people who don't know can't write good code just by reading "write good code". I think `CONTRIBUTING.md` should focus only on the git/vcs side of things.

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Bewertung

Dieses Issue wurde noch nicht bewertet.

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.