Add a list of upcoming breaking changes
Open
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 269
- Forks
- 105
- PR merge metrics
- No merged PRs in 30d
Description
We try to avoid breaking changes in Pelias, but sometimes they are required.
While we have a roadmap document for new features, it might make sense to explicitly call out things that we expect or plan to build a breaking change around soon.
Some examples of what we could list currently:
Contributor guide
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 with development/roadmap.md, which is the existing roadmap document referenced by the issue, and review the linked Pelias, Who’s On First, and interpolation items. Add a clearly labeled list or section for planned breaking changes, preserving links to the relevant issues and pull request; done means the upcoming changes are easy to find and understand.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- elasticsearch, node.js
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100