add notes on python-seed template features

Open
#16 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
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
github, python
Domain
documentation

Research direction

Review the template README and identify where notes on pre-commit, tox, tests, the CLI, and CI should be added. Include the requested pre-commit and tox notes in the template README, and consider both GitHub and CircleCI; the documentation is done when all listed template features are covered.

Written by the indexing model from the issue text.

Description

  • pre-commit (should be added in template readme too)
  • tox (should be added in template readme too)
  • tests
  • cli
  • CI (github/circleci)
Dominant language
Python
Stars
21
Forks
4
PR merge metrics
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 developmentseed/python-seed

All issues in developmentseed/python-seed

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.