aboutcode-org / aboutcode-org/aboutcode

Create org-modified unified contributing guide and related coding standards

Open
#186 4 comments 0 reactions 2 assignees Claimed by @TG1999 View on GitHub
documentation policy
Dominant language
Batchfile
Stars
302
Forks
249
Avg merge
1d 9h
Merged PRs (30d)
2

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.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.