labcodes / labcodes/django-react-boilerplate

Keep a changelog

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

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
45
Forks
6
PR merge metrics
No merged PRs in 30d

Description

I liked the way that's pytest structure the changelog

https://github.com/pytest-dev/pytest/tree/main/changelog

It uses towncrier over the hood
https://pypi.org/project/towncrier/

And also have a good pull-request template: https://raw.githubusercontent.com/pytest-dev/pytest/main/.github/PULL_REQUEST_TEMPLATE.md

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

Start by reviewing pytest’s changelog directory and .github/PULL_REQUEST_TEMPLATE.md examples, then read the towncrier documentation linked in the issue. Compare those approaches with this repository’s current structure. Done means the requested changelog workflow and pull-request template are added and usable.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.