Create org-modified unified contributing guide and related coding standards
@TG1999 is already working on this.
Since Mar 27, 2025.
Assessment
This issue has not been assessed yet.
Description
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.
- Dominant language
- Batchfile
- Stars
- 316
- Forks
- 257
- PR merge metrics
- No merged PRs in 30d
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from aboutcode-org/aboutcode
-
Cross-reference OpenChain CRA Compliance ChecklistMay be free again @PaulitePavitra claimed this 41 days ago, and no pull request is open. Open
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
aboutcode-org/aboutcode#309 · 6 comments ·
-
scancode-next: Plan federated software supply chain data infrastructurePossibly taken @ziadhany claimed this 6 days ago. Openmaintainers-only
Difficulty 4/5 3-5 days Newbie friendliness 45/100
aboutcode-org/aboutcode#325 · 2 comments · 2 assignees ·
-
scancode-next: Improve documentation, review documentation issues and pull requestsPossibly taken @hesa claimed this 8 days ago. Openmaintainers-only
aboutcode-org/aboutcode#324 · 1 assignee ·
-
scancode-next: Gather requirements through interviews with key usersPossibly taken @hesa claimed this 8 days ago. Openmaintainers-only
Difficulty 5/5 Over a week Newbie friendliness 25/100
aboutcode-org/aboutcode#323 · 1 assignee ·
-
scancode-next: Prepare ScanCode and AboutCode workshopsPossibly taken @adaaaam claimed this 6 days ago. Openmaintainers-only
aboutcode-org/aboutcode#322 · 1 assignee ·