Feature: Add CONTRIBUTING.md scaffold
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 45/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Domain
- documentation
Research direction
Read the linked issue #21 and the referenced Puppet and factory_girl_rails CONTRIBUTING.md examples first. Done means adding a general CONTRIBUTING.md to create-module with agreed guidance on checking issues, proposing work, forking, branching, testing, and opening a pull request.
Written by the indexing model from the issue text.
Description
@dshaw suggested we should add a CONTRIBUTING.md file that outlines directions in contributing.
https://github.com/nodeconf/Adventure-UNCONF/issues/21
One example provided by github themselves was puppet
https://raw.githubusercontent.com/puppetlabs/puppet/master/CONTRIBUTING.md
or from factory_girl_rails
https://raw.githubusercontent.com/thoughtbot/factory_girl_rails/master/CONTRIBUTING.md
Should the scaffolding be a general outline? Something likes this?
1.) Check past issues to see if the feature request has been made.
2.) Something about suggesting/requesting in the project's issues page
3.) Fork the project
4.) Review the code
5.) branch code from master, add feature, test feature, push branch aka make pull request
👍 or 👎
- Dominant language
- JavaScript
- Stars
- 32
- Forks
- 4
- PR merge metrics
- No merged PRs in 30d
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
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 finnp/create-module
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
finnp/create-module#19 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 35/100
finnp/create-module#8 · 4 comments ·
-
Difficulty 5/5 Over a week Newbie friendliness 25/100
finnp/create-module#7 · 1 comment ·
-
Add automatic CIOpen
Difficulty 5/5 Over a week Newbie friendliness 30/100
finnp/create-module#2 ·
All issues in finnp/create-module
Similar issues
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
capricorn86/happy-dom#2485 ·
Maintainers usually reply within 2 days
-
Difficulty 2/5 Under an hour Newbie friendliness 74/100
siyuan-note/siyuan#20429 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
Maintainers usually reply within 2 days
-
Difficulty 1/5 Under an hour Newbie friendliness 72/100
yjh051108/dsh-routing-suite#216 ·
-
[Bug] Completion info popup (.cm-completionInfo) ignores the configured editor fontPossibly taken A pull request linked to this issue is open or already merged. Openbug user-priority/P2
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
Maintainers usually reply within 1 day