BIRDSOpenSource / BIRDSOpenSource/BIRDS4-OBC

add CONTRIBUTING guidelines document

Open
#4 0 comments 1 reaction 0 assignees View on GitHub
documentation good first issue
Dominant language
C
Stars
7
Forks
0
PR merge metrics
No merged PRs in 30d

Description

Simply create a document called CONTRIBUTING.md in the root of the repository, use it to describe the preferred issue reporting workflow, and

Make sure to emphasize the importance of submitting issues for anything that the user does not understand.

[Feel free to draw inspiration from here](https://github.com/microsoft/vscode/blob/cf4c4a0ece70d221d907a2bc0042cc164f73bb0c/CONTRIBUTING.md)

Contributor guide

No contributing guide indexed for this repository

Research direction

Create CONTRIBUTING.md at the repository root. First review the linked VS Code CONTRIBUTING.md for structure, then document the preferred issue-reporting workflow and emphasize reporting anything users do not understand; done means the file contains both requirements and is committed at the root.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.