MarketSquare / MarketSquare/robotframework-style-guide
Create CONTRIBUTING.md
Nobody has claimed this yet.
- Dominant language
- RobotFramework
- Stars
- 29
- Forks
- 5
- PR merge metrics
- No merged PRs in 30d
Description
Create a document for rules for submitting work items in the style guide.
See example: https://github.com/robotframework/robotframework/blob/master/CONTRIBUTING.rst
Leverage the `Good First Issue` and `Help Needed` Label from Github (actually use it)
`Edit Page` button at bottom of guides pages.
Paths to contributing:
- Create an issue in github
- Work on an issue (github process outlined via chart)
- Simple Edits `Edit Page`
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 reading the linked Robot Framework CONTRIBUTING.rst example and inspecting the repository's guides pages and existing GitHub labels. Define CONTRIBUTING.md around the three listed contribution paths, including the issue workflow chart, Edit Page guidance, and Good First Issue/Help Needed labels. Done means the document covers each requested path and is linked or discoverable from the guides.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100