Skip to content

Latest commit

 

History

History
75 lines (53 loc) · 6.7 KB

README.md

File metadata and controls

75 lines (53 loc) · 6.7 KB
Raw

Eiffel Intelligence

Eiffel Intelligence is a real time data aggregation and analysis solution for Eiffel events. While Eiffel represents an event based architecture, Eiffel Intelligence addresses the need of stakeholders to view the current state of the system by bridging the divide from immutable events to mutable state representation.

This repository contains a software implementation based on the Eiffel protocol. For more information on Eiffel, its vocabulary, descriptions, guides and schemas, please see the Eiffel repository. For news, discussions and questions, please visit the Eiffel Community Google group.

Eiffel Intelligence is licensed under the Apache License 2.0.

How to Propose Changes

Anyone is welcome to propose changes to this repository by creating a new Issue ticket in GitHub. These requests may concern anything contained in the repo: changes to documentation, changes to interfaces, changes to implementations, additional tests 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 collaborative software develpoment 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.

How to Contribute

Contributions can be made by anyone using the standard GitHub Fork and Pull model. When making a pull request, keep a few things in mind.

  1. Always explicitly connect a pull request to an Issue. See How to Propose Changes above for further information.
  2. Make sure you target the correct branch. If you are unsure which branch is appropriate, ask in the Issue thread.
  3. Pull Requests will be publicly reviewed, criticized, and potentially rejected. Don't take it personally.

Reviewing and Merging Pull Requests

We use the Squash and Merge model, which means that all commits in a Pull Request get squashed into a single commit in the target branch. In other words, the revision history will look like a string of single commits corresponding one-to-one with Issues.

Pull requests can be merged by members of the Eiffel team. There is a certain protocol to adhere to, however, as well as expectations on membership.

  1. All members of the Eiffel team are expected to make the effort to participate in the review of Pull Requests. Every member may not review everything in detail, but everyone can make the effort to chime in on some. Remember that expedient high quality reviews are crucial to the long term survival of any open source project.
  2. Eiffel team members are strongly encouraged to participate in reviews even if they do not feel entirely qualified to assess the pull request. Looking at changes and participating in review discussions is one of the best ways to learn, and presents an excellent opportunity to ask questions. And remember, participating in a review is not the same as having to make the final decision.
  3. Anyone can participate in reviews, not only Eiffel team members.
  4. A Pull Request should be approved by at least two Eiffel team members (including the one doing the merging). For this to function well, the above point on participation is critical.
  5. Do not feel any pressure to merge Pull Requests. Unless you feel confident about what you are doing, don't press that big green button. Instead, ask a more senior member to make the decision.
  6. When squashing and merging, ensure that the description reflects the change. Detailing every individual commit in the Pull Request is unnecessary, as they are squashed anyway. Instead, describe the change as a single thing. That description should always include an Issue reference, and should focus on WHY the change was made, to provide the reader with context. See this excellent guide on writing good commit messages.

License Management

To be accepted into the repository, contributions must be licensed under the Apache License 2.0. Consequently, a license notice shall be included in suitable comment syntax where applicable. This license notice shall state the copyright holder(s) and point to the commit history for a full list of individual contributors, on the following format:

Copyright <Year(s)> <Copyright holder of original contribution [and others].>
For a full list of individual contributors, please see the commit history.

The copyright holder is either the individual contributor if they act on their own behalf, or any organization on whose behalf they contribute. When multiple copyright holders have contributed to the same file, the copyright notice shall be appended "and others". The copyright year(s) shall reflect the year(s) of contribution(s) and be updated accordingly when new contributions are made to the file. To exemplify, the copyright notice of an original contribution made by Jane Doe acting on behalf of Ericsson AB may read:

Copyright 2017 Ericsson AB.
For a full list of individual contributors, please see the commit history.

When John Doe, acting on his own behalf, makes a subsequent addition to the same file, the notice will be updated accordingly:

Copyright 2017 Ericsson AB and others.
For a full list of individual contributors, please see the commit history.

When John Doe makes a subsequent contribution the following year, the notice will again be updated:

Copyright 2017-2018 Ericsson AB and others.
For a full list of individual contributors, please see the commit history.