gitpoint / gitpoint/git-point

Proposal - Maintaining a ChangeLog

Open
#505 7 comments 3 reactions 0 assignees View on GitHub
discussion
Dominant language
JavaScript
Stars
4.8k
Forks
771
PR merge metrics
No merged PRs in 30d

Description

I wrote an initial ChangeLog in #504 to help us follow through the tons of changes between versions.

I went through the closed PR since GitPoint was published on github, and I curated the list.
(@housseindjirdeh I'm not sure what was in 1.2 and what was in 1.3 though).

The idea would be to update this file every time a PR is merged carrying a _significant_ change to GitPoint. (and RN versions upgrades which seemed important to me)

These changes should be relevant to the end-user, and be formatted as follow:
- Added XXXXXX (#PR_NUMBER)
- Fixed XXXXXX (#PR_NUMBER)

Minor cosmetic/ui/ux fixes and changes shouldn't be written down. Neither should build related stuff.

The ChangeLog should also be updated with every release of the app to add the version number, release date & create a new master section.

Opinions ?

Contributor guide

Open the contributing guide

Research direction

Start with the initial ChangeLog referenced in issue #504, then review the closed pull requests since GitPoint was published to compare the curated entries. Confirm how release versions and dates should be grouped, and document the agreed format for significant user-facing changes while excluding cosmetic and build changes.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.