GenderMagProject / GenderMagProject/GenderMagRecordersAssistant

Expand and Verify Contributing Guide

Open
#86 1 comment 0 reactions 0 assignees View on GitHub
Enhancement Good First Issue High Priority
Dominant language
JavaScript
Stars
29
Forks
68
PR merge metrics
No merged PRs in 30d

Description

The instructions in the contributing guide need to be verified for clarity and completeness - they should be tested and any additional information needed should be added.

Additionally, these changes should be made:

* Fix formatting: list formatting should be either bullets or numbers but not both
* 'To Contribute' section should be cleaned up and more detailed, the multiple parentheses make it confusing. This section should probably reference GitHub documentation on how to execute pushing/pulling/pull requests.
* There needs to be a reference to style guidelines as described in #77
* From #34: The instructions should be clear about which repository should be used to create a branch i.e. the main repository or the fork (Should probably be a branch from the contributor's fork)
* From #34: In step three the phrase pop-up box should be removed.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.