Create org-wide contributing document
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Domain
- documentation
Research direction
Review the linked contributing documents for aboutcode, vulnerablecode, scancode.io, and DejaCode, comparing their guidance and structure. Create the requested org-wide contributing document using those references as starting points. Done means the organization has a single contributing document covering the needed guidance.
Written by the indexing model from the issue text.
Description
Create org-wide contributing document. This is needed. These are good starting points:
- https://github.com/aboutcode-org/aboutcode/blob/96bfba0dc9496fcbb335d0aa41d1a7b815d1796f/docs/source/contributing/contrib_doc.rst
- https://github.com/aboutcode-org/vulnerablecode/blob/d1f4c74610b52cff5a506e39662ad15f0f7df1ba/docs/source/contributing.rst#L3
- https://github.com/aboutcode-org/scancode.io/blob/6e131c63126be4266746b20fff8e37505f9606d2/docs/contributing.rst#L2
- https://dejacode.readthedocs.io/en/latest/contributing.html
- Dominant language
- Batchfile
- Stars
- 316
- Forks
- 257
- PR merge metrics
- No merged PRs in 30d
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
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 aboutcode-org/aboutcode
-
Cross-reference OpenChain CRA Compliance ChecklistMay be free again @PaulitePavitra claimed this 41 days ago, and no pull request is open. Open
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
aboutcode-org/aboutcode#309 · 6 comments ·
-
scancode-next: Plan federated software supply chain data infrastructurePossibly taken @ziadhany claimed this 6 days ago. Openmaintainers-only
Difficulty 4/5 3-5 days Newbie friendliness 45/100
aboutcode-org/aboutcode#325 · 2 comments · 2 assignees ·
-
scancode-next: Improve documentation, review documentation issues and pull requestsPossibly taken @hesa claimed this 8 days ago. Openmaintainers-only
aboutcode-org/aboutcode#324 · 1 assignee ·
-
scancode-next: Gather requirements through interviews with key usersPossibly taken @hesa claimed this 8 days ago. Openmaintainers-only
Difficulty 5/5 Over a week Newbie friendliness 25/100
aboutcode-org/aboutcode#323 · 1 assignee ·
-
scancode-next: Prepare ScanCode and AboutCode workshopsPossibly taken @adaaaam claimed this 6 days ago. Openmaintainers-only
aboutcode-org/aboutcode#322 · 1 assignee ·
All issues in aboutcode-org/aboutcode
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 78/100
firefly-iii/firefly-iii#13259 · 3 comments ·
Maintainers usually reply within 1 day
-
documentation
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
molgenis/molgenis-emx2#7059 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
[DOCS/SMU] Correct the 1 GiB window bullet and the coverage-target sentence in the SMU datasheetOpenDOCS SMU
Difficulty 2/5 1-3 hours Newbie friendliness 77/100
tenstorrent/tt-oca-harness#3931 ·
Maintainers usually reply within 1 day
-
[Sync EN] Document the getLastErrors() return value change in the PHP 8.2 migration guide (#6107)Opensync-en
Difficulty 1/5 Under an hour Newbie friendliness 78/100
Maintainers usually reply within 1 day