NatLabRockies / NatLabRockies/developer.nlr.gov
Add API changelogs
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 60
- Forks
- 57
- Avg merge
- 1d 21h
- Merged PRs (30d)
- 3
Description
I think we should start maintaining public CHANGELOGs for our individual APIs. In a variety of cases, we continue to add new features to a specific version of an API (while maintaining backwards compatibility), but we don't necessarily do a good job announcing those enhancements or making the history of the API publicly available. While we could do a lot more to announce changes, a simple CHANGELOG of dates and when things happened for each API would be a good, simple place to start.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by identifying the individual APIs covered by this repository and how their public documentation is organized. Define where each API's CHANGELOG should live and what dated history it must contain; the work is done when the agreed changelogs are publicly available for the relevant APIs.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100