aboutcode-org / aboutcode-org/aboutcode

Create org-modified unified contributing guide and related coding standards

未关闭
#186 4 条评论 0 个 reaction 已指派 2 人 已被 @TG1999 认领 在 GitHub 查看
documentation policy
主要语言
Batchfile
星标
302
派生
249
平均合并
1 天 9 小时
30 天内合并 PR
2

描述

### Description

We have many places for this like in:
- https://scancodeio.readthedocs.io/en/latest/contributing.html
- See https://github.com/search?q=org%3Aaboutcode-org+contributing+language%3AreStructuredText&type=code&l=reStructuredText

We need to have a single org-wide document that unifies all these practices with a single set of documentation.

Some other recommendations to add:
- small, focused PRs
- adopting existing code style in a repo
- avoiding the introduction of new dependencies unless absolutely needed

The goal is to start with python-inspector as a base repo to refine this.

Also to consider is how to update tools used across repos for this, like black vs. ruff and use the skeleton for this or scripts.

贡献指南

打开贡献指南

评估

这个 Issue 还没有评估数据。

把新 issue 发到你的邮箱

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