openfab-lab / openfab-lab/rtfm
fichier détaillant comment contribuer (via opensource.guide)
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 0
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
@nicolasdb commented on Sun Jun 25 2017
CONTRIBUTING
ref to file.md or #issue : https://github.com/openfab-lab/openfab/blob/master/CONTRIBUTING.md
Ce fichier est proposé maintenant automatiquement en haut quand on crée une nouvelle issue :D
contexte
J'ai commencé à lire https://opensource.guide/
Ils y expliquent pas mal de chose pour les noobs (comme nous entre autre) dont des conseils comme avoir toutes les indications, le cadre, pour permettre aux gens de participer.
objectif
Il est conseillé d'avoir à la racine du dépôt:
- Readme.md
- Code of conduct (réglème d'ordre intérieur)
- Contributing (comment contribuer au projet)
- Licence (sous quel type de licence on partage notre travail)
https://github.com/openfab-lab/openfab/community
proposition
J'ai commencé un document comme conseillé en reprenant des choses que j'aimais bien dans le doc "how to contribute to OS" mais surtout j'y ai rappeler le template à utiliser pour les issues.
ça me parait important d'y travailler à plusieurs ainsi que sur les autres fichier comme "code of conduct", le règlement d'ordre intérieur.
inspirations
@nicolasdb commented on Mon Sep 25 2017
j'ai trouvé un chouette et simple exemple
https://github.com/HandBrake/HandBrake#contributing
comme tjs, faut adapter mais j'aime bien la simplicité du msg.
@nicolasdb commented on Sun Nov 26 2017
Bon ben, nouvelle idée.
Vu que dans mon site web github, j'ai une page "how to contribute"
J'ai créé un label "how to contribute" + le "good first issue" (pour les noobs)
Lorsqu'on crée une nouvelle issue, on peut ajouter ces deux ci pour préciser les tâches où l'on peut aider, + celle qui sont facile pour débuter.
Il suffit de tps en tps de vérifier ces issues et les lister dans la "how to contribute" et d'y décrire bien sur comment on commence (lien vers tuto git101)
Contributor guide
No contributing guide indexed for this repository
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.
Research direction
Start by reviewing the existing CONTRIBUTING.md and the guidance from opensource.guide. Compare the proposed contribution guidance with the repository’s README.md, code of conduct, licence, and issue templates. Done would require an agreed scope and updated project documentation explaining how to contribute.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100