Create CONTRIBUTING.md file

Open
#51 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
55/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
python
Domain
documentation

Research direction

Start by inspecting the repository's development setup, code style, testing requirements, pull request process, and issue-reporting practices. Create CONTRIBUTING.md covering each of the five listed areas; it is done when contributors can find all requested guidelines there.

Written by the indexing model from the issue text.

Description

bug community documentation enhancement module:ui priority:medium

Add contribution guidelines for the project.

Content to include:

  • Development setup instructions
  • Code style guidelines
  • Testing requirements
  • Pull request process
  • Issue reporting guidelines
Dominant language
Python
Stars
2
Forks
0
Avg merge
18h 8m
Merged PRs (30d)
14

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.

More from falkcorp/github-common

All issues in falkcorp/github-common

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.