dusk-network / dusk-network/.github

Add supplemental information to contribution guideline

Open
#12 0 comments 0 reactions 1 assignee View on GitHub

@autholykos is already working on this.

Since Oct 3, 2021.

type:docs type:enhancement
Dominant language
No language data
Stars
2
Forks
3
Avg merge
19m
Merged PRs (30d)
1

Description

Describe what kind of specification you want to have created
The CONTRIBUTING.md could benefit from:

  • A TOC
  • A direct link to opening issues ../issues/new
  • Some basic Go/Rust/Javascript styleguides
  • Some more information about how to communicate with the team (Discord, mailinglist, etc).
  • Some high level information for different kind of contributions

For inspiration see Atom's and RoR contribution guidelines.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.