CONTRIBUTE.md

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

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
45/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
git, github
Domain
documentation, release

Research direction

Create the named CONTRIBUTE.md file and use the issue checklist as its required scope. Start by documenting GitHub release tagging, SEMVER practices, and the Gitflow relationship between main, develop, and release-x.y.z; done when the file covers all three practices and the unchecked tagging item is addressed.

Written by the indexing model from the issue text.

Description

We should start a CONTRIBUTE.md file, describing a few practices about to ramp up around development:

  • Tagging releases on Github.
  • Treating releases with SEMVER practices.
  • Following a Gitflow merge model, at least through main vs. develop vs. release-x.y.z merging into main and develop.
Dominant language
Python
Stars
20
Forks
6
No merged PRs in 30d

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.

More from dfxml-working-group/dfxml_python

All issues in dfxml-working-group/dfxml_python

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.