Create org-modified unified contributing guide and related coding standards

Open
#186 4 comments 0 reactions 2 assignees View on GitHub

@TG1999 is already working on this.

Since Mar 27, 2025.

  • #220 by @vaibhav11123 — open
  • #221 by @vaibhav11123 — open
  • #240 by @im-anishraj — open

Assessment

This issue has not been assessed yet.

Description

documentation policy
Description

We have many places for this like in:

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

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from aboutcode-org/aboutcode

All issues in aboutcode-org/aboutcode

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.