Aligned with eiffel-community repository guidelines #193
Conversation
…#192) As per issue eiffel-community#192, followed the eiffel-community repository guidelines. - Added Eiffel Protocol logo to README. - Updated README to stay consistent with other repositories. - Removed links to implementations, instead referring to the Eiffel Community web page. - Updated CODE_OF_CONDUCT and CONTRIBUTING files.
README.md
Outdated
|
|
||
| Eiffel is licensed under the [Apache License 2.0](./LICENSE). | ||
| This repository contains the Eiffel protocol vocabulary, descriptions, guides and schemas. For implementations, implementations, architecture and community resources, visit the [Eiffel Community](https://eiffel-community.github.io). |
There was a problem hiding this comment.
repetition...
implementations, implementations
There was a problem hiding this comment.
Thanks! Fixed.
README.md
Outdated
| ## Contents | ||
| To get involved, please see [Code of Conduct](./CODE_OF_CONDUCT.md) and [contribution guidelines](./CONTRIBUTING.md). | ||
|
|
||
| # About Eiffel |
There was a problem hiding this comment.
I think the Eiffel Protocol above and this section 'About Eiffel' does not really make the distinction between Eiffel and the Eiffel Protocol clear enough, instead it adds to the confusion betweem them. The Eiffel Community manages a protocol and a set of implementations enabling the use of that protocol. Now, some text in 'Eiffel Protocol' above is duplicated but slightly reformulated in this 'About Eiffel' section. I think this 'About Eiffel' section is redundant and can be removed, while some of its details or phrasing could possibly be moved to the 'Eiffel Protocol' section above.
There was a problem hiding this comment.
You're right. I would solve it differently, though. The "About Eiffel" section is copy-pasted from the eiffel-community repository template, and there's a point to being consistent across repositories. Instead I removed the redundant statements in the first paragraph.
What do you think, does that work?
| 1. Activity Orchestration | ||
| 1. Event Transport and Routing | ||
| 1. [Event Dispatch](./implementations/event-dispatch.md) | ||
| 1. [Visualization](./implementations/visualization.md) | ||
| 1. Extensions | ||
| 1. [Eiffel Operations Extension](https://github.com/Ericsson/eiffel-operations-extension) |
There was a problem hiding this comment.
This is probably the only (?) reference to old Ericsson labeled stuff in this repository. I understand it is not feasible to move that to eiffel-community within this PR, but maybe the link should have an accompanying comment stating that it is planned to be moved to eiffel-community in due time?
There was a problem hiding this comment.
I disagree. Sure, we can move the operations extension to eiffel-community if those involved in it wish to do so (although that would actual active maintainers). That's beside the point, though - extensions could be provided by John Doe and his second cousins and be published wherever for all I care. This one just happens to be hosted by the Ericsson organization.
Does that make sense?
|
I'm fine with this PR now. |
As per issue #192, followed the eiffel-community repository guidelines.
Applicable Issues
#192
Description of the Change
Eiffel Community web page.
Alternate Designs
n/a
Benefits
Consistency across eiffel-community repositories.
Possible Drawbacks
n/a
Sign-off
Developer's Certificate of Origin 1.1
By making a contribution to this project, I certify that:
(a) The contribution was created in whole or in part by me and I
have the right to submit it under the open source license
indicated in the file; or
(b) The contribution is based upon previous work that, to the best
of my knowledge, is covered under an appropriate open source
license and I have the right under that license to submit that
work with modifications, whether created in whole or in part
by me, under the same open source license (unless I am
permitted to submit under a different license), as indicated
in the file; or
(c) The contribution was provided directly to me by some other
person who certified (a), (b) or (c) and I have not modified
it.
(d) I understand and agree that this project and the contribution
are public and that a record of the contribution (including all
personal information I submit with it, including my sign-off) is
maintained indefinitely and may be redistributed consistent with
this project or the open source license(s) involved.
Signed-off-by: Daniel Ståhl [email protected]