eiffel-community / eiffel-community/community

Provide Guidelines on version handling of endpoints across the eiffel-community

Open
#35 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
No language data
Stars
5
Forks
15
PR merge metrics
No merged PRs in 30d

Description

Description

There is no common guidelines about how to support the version handling and how long we should support the deprecated endpoints. This issue is create to make a guidelines available across the community so that we adhere the same across different repositories

Motivation

We have different repositories adhering to different ways w.r.t version handling of endpoints, so this can be brought in as a common way to support them.

Exemplification
Benefits
Possible Drawbacks

Contributor guide

Open the contributing guide

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

Review how different Eiffel Community repositories currently handle endpoint versions and deprecated endpoints. Use those differences to define common guidance for version handling and support duration, then publish the agreed guidelines so repositories can follow the same approach.

Written by the indexing model from the issue text.

Assessment

Domain
api, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.