aboutcode-org / aboutcode-org/aboutcode

Create org-modified unified contributing guide and related coding standards

Đang mở
#186 4 bình luận 0 reaction 2 người được giao Được @TG1999 nhận Xem trên GitHub
documentation policy
Ngôn ngữ chính
Batchfile
Star
302
Fork
249
Merge trung bình
1 ngày 9 giờ
Pull request đã merge (30 ngày)
2

Mô tả

### 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.

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Đánh giá

Issue này chưa được đánh giá.

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.