aboutcode-org / aboutcode-org/aboutcode

Create org-modified unified contributing guide and related coding standards

Ouverte
#186 4 commentaires 0 réactions 2 personnes assignées Réclamée par @TG1999 Voir sur GitHub
documentation policy
Langage dominant
Batchfile
Étoiles
302
Forks
249
Merge moyen
1 j 9 h
PR mergées (30 j)
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.

Guide de contribution

Ouvrir le guide de contribution

Évaluation

Cette issue n'a pas encore été évaluée.

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.