cowprotocol / cowprotocol/contracts

Contributor guidelines

Open
#205 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Solidity
Stars
158
Forks
56
Avg merge
9h 40m
Merged PRs (30d)
1

Description

We should introduce contributor guidelines.

They could include:

  • in which issue/prs we are looking for contributions (`help wanted tag?)
  • code style (loosely follow Natspec?)
  • expectations on git (avoid rebase, small PRs?)

and anything else I'm probably forgetting about.

We already had a contributor who was interested in them but we couldn't provide any.

Contributor guide

No contributing guide indexed for this repository

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.

Research direction

No file or test is named. Start by reviewing the linked help-wanted label, Solidity style guide, and prior discussion in issue #122; done means publishing agreed contributor guidelines covering contribution opportunities, code style, Git expectations, and any other required project practices.

Written by the indexing model from the issue text.

Assessment

Tech stack
solidity
Domain
blockchain, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.