Skip to content

Latest commit

 

History

History
38 lines (29 loc) · 2.81 KB

how-to-propose-changes.md

File metadata and controls

38 lines (29 loc) · 2.81 KB

How to Propose Changes

Anyone is welcome to propose changes to the Eiffel protocol by creating a new Issue ticket in GitHub. These requests may concern anything contained in the repo: changes to documentation, changes to definitions, requests for additional information, additional event types, requests for additional examples et cetera.

When posting a new issue, try to be as precise as possible and phrase your arguments for your request carefully. Keep in mind that defining a shared protocol is often an exercise in finding workable compromises between multiple and often conflicting needs. In particular, pay attention to the following:

  1. What type of change is requested?
  2. Why would you like to see this change?
  3. Can you provide any concrete examples?
  4. Which arguments in favor can you think of?
  5. Which arguments against can you think of, and why are they outweighed by the arguments in favor?

Also, keep in mind that just as anyone is welcome to propose a change, anyone is welcome to disagree with and criticize that proposal.

Closing Issues

An Issue can be closed by any member of the Eiffel team. This can happen in various ways, for varying reasons:

  1. Issues without conclusion and no activity for at least 14 days may be closed, as a mere housekeeping activity. For instance, an Issue met with requests for further clarification, but left unanswered by the original author, may simply be removed.
  2. Issues may simply be rejected if found unfeasible or undesirable. In such cases they shall also be responded to, providing a polite and concise explanation as to why the proposal is rejected.
  3. Issues may be closed because they are implemented. Following the successful merging of a pull request addressing an Issue, it will be closed.

Proposing Solutions

While we welcome requests for changes (in the form of Issues), we absolutely love ready solutions (in the form of Pull Requests). The best requests are the ones with a Pull Request to go along with it. For more information on how to contribute a Pull Request, please see How to Contribute.