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 摘要。