amfoss / amfoss/root

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

未关闭
#136 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
documentation good first issue
主要语言
Rust
星标
4
派生
23
PR 合并指标
30 天内没有已合并 PR

描述

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.

贡献指南

这个仓库没有索引到贡献指南

评估

这个 Issue 还没有评估数据。

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。