Skip to content

Commit

Permalink
Merge pull request eclipse-iceoryx#410 from ApexAI/iox-#356-contribut…
Browse files Browse the repository at this point in the history
…ions-rework

iox-eclipse-iceoryx#356 Add proposal for iceoryx developer meetup
  • Loading branch information
mossmaurice authored Dec 10, 2020
2 parents 1574dca + 3e5f32d commit dd8a786
Show file tree
Hide file tree
Showing 3 changed files with 111 additions and 26 deletions.
50 changes: 28 additions & 22 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,36 +8,20 @@ In domains like automotive, robotics or gaming, a huge amount of data must be
transferred between different parts of the system. If these parts are actually
different processes on a POSIX based operating system like Linux, this huge
amount of data has to be transferred via an inter-process-communication (IPC)
mechanism.

* https://projects.eclipse.org/projects/technology.iceoryx

## Developer resources

Information regarding source code management, builds, coding standards, and
more.

* https://projects.eclipse.org/projects/technology.iceoryx/developer

The project maintains the following source code repositories

* https://github.com/eclipse/iceoryx
mechanism. Find more infos on the [Eclipse site](https://projects.eclipse.org/projects/technology.iceoryx).

## Eclipse Contributor Agreement

Before your contribution can be accepted by the project team, contributors must
electronically sign the Eclipse Contributor Agreement (ECA).

* http://www.eclipse.org/legal/ECA.php
electronically sign the Eclipse Contributor Agreement ([ECA](http://www.eclipse.org/legal/ECA.php)).

Commits that are provided by non-committers must have a Signed-off-by field in
the footer indicating that the author is aware of the terms by which the
contribution has been provided to the project. The non-committer must
additionally have an Eclipse Foundation account and must have a signed Eclipse
Contributor Agreement (ECA) on file.

For more information, please see the Eclipse Committer Handbook:
https://www.eclipse.org/projects/handbook/#resources-commit
For more information, please see the [Eclipse Committer Handbook](https://www.eclipse.org/projects/handbook/#resources-commit).

## Contact

Expand All @@ -48,9 +32,21 @@ Contact the project developers via the project's "dev" list.
## Feature request and bugs

We love pull requests! The next sections try to cover most of the relevant questions. For larger contributions or
architectural changes, we'd kindly ask you to get in touch with one of the maintainers beforehand. If you would like to
report a bug or propose a new feature, please raise an issue before raising a pull request. This makes it easier to
track. Please make sure you have:
architectural changes, we'd kindly ask you to either:

* Raise the proposed changes during a [developer meetup](https://github.com/eclipse/iceoryx/wiki/Developer-meetup)

or

* Create a design document and raise it in a separate pull request beforehand

If you would like to report a bug or propose a new feature, please raise an issue before raising a pull request.
Please have a quick search upfront if a similar issue already exists. An
[release board](https://github.com/eclipse/iceoryx/projects) is used to prioritise the issues for a specific release.
This makes it easier to track the work-in-progress. If you have troubles getting an issue assigned to you please
contact the maintainers via [Gitter](https://gitter.im/eclipse/iceoryx).

Please make sure you have:

1. Signed the [Eclipse Contributor Agreement](http://www.eclipse.org/legal/ECA.php)
1. Created an issue before creating a branch, e.g. `Super duper feature` with issue number `123`
Expand Down Expand Up @@ -294,3 +290,13 @@ This quality level is meant for all targets that need tier 1 support in ROS2.

* Warnings in Helix QAC addressed
* Code coverage according to [MC/DC](https://en.wikipedia.org/wiki/Modified_condition/decision_coverage) available

## Training material recommended for contributors

* Effective C++ by Scott Meyers
* [Unit Testing and the Arrange, Act and Assert (AAA) Pattern](https://medium.com/@pjbgf/title-testing-code-ocd-and-the-aaa-pattern-df453975ab80) by Paulo Gomes
* The C++ Standard Library by Nicolai M. Josuttis
* Modern C++ Programming with Test-Driven Development: Code Better, Sleep Better by Jeff Langr
* Modern C++ Design: Generic Programming and Design Patterns by Andrei Alexandrescu
* Exceptional C++ by Herb Sutter
* C++ Concurrency in Action by Anthony Williams
79 changes: 79 additions & 0 deletions GOVERNANCE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
# Eclipse iceoryx governance

Eclipse iceoryx is governed democratically by its maintainers under the umbrella of [OpenADx](https://openadx.eclipse.org/).
This document describes the processes additionally to the [Eclipse process](https://www.eclipse.org/projects/handbook/).

## Maintainers

An up to date list of the maintainers can be found at the [Eclipse project page](https://projects.eclipse.org/projects/technology.iceoryx/who).

## Bi-weekly meetup

Bi-weekly every Thursday for 1 hour. Everyone is welcome to join.

You can join by using this Zoom link: **ADD LINK HERE**

```
08:00 PST (GMT - 8)
16:00 GMT
17:00 CET (GMT + 1)
21:30 IST (GMT + 5.5)
23:00 CST (GMT + 7)
```

### Topics

* Propose features
* E.g. present and discuss a design document
* Discuss pull requests without going into details
* E.g. a small demo
* Steer direction of Eclipse iceoryx
* Go over the current release board under Projects
* E.g. go over the milestone list and move the issues between the three prio's
* Raise and answer questions
* Discuss tooling and infrastructure
* All others topics related to iceoryx one can think of

> Friendly-reminder:
>
> * Discussions about technical issues or in-depth topics should be **avoided**, e.g. "Why is my build broken? I need help"
> * Please stick to the agenda, stay on the topic and move side topics to other meetings
### Meeting minutes

Meetinges minutes are stored in the [wiki](https://github.com/eclipse/iceoryx/wiki/Developer-meetup).
An Eclipse maintainer will save the meeting minutes on a new page for every meeting.

If you have points that you want to discuss, please send your points to the [mailing list](mailto:[email protected]) a couple of days before.

#### Minutes template

```
# Eclipse iceoryx developer meetup
Date: 1st January 1900
Time: 17:00 CET
## Attendees
* Max Mustermann, [email protected]
* John Doe, [email protected]
## Agenda
1. General: Introduction of new participations, 42 mins
2. General: Are there other agenda points?, 8 mins
3. Agenda point 1, 4 mins
4. Agenda point 2, 4 mins
## Minutes
### Agenda point 1
* Add discussion here
### Agenda point 2
* Add discussion here
```
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,8 @@ Please see the dedicated [README.md](tools/docker/README.md) for information on
| iceoryx_utils | 1 | 4 | |
| iceoryx_introspection | 5 | 5 | |

Is something missing or you've got ideas for other nifty examples? Jump right away to the next section!

## Contribute

Please refer to the [CONTRIBUTING.md](./CONTRIBUTING.md) for a quick read-up about what to consider if you want to contribute.
Expand All @@ -107,8 +109,6 @@ Get to know the upcoming features and the project scope in [PLANNED_FEATURES.md]
| [iceoryx-rs](https://github.com/elBoberido/iceoryx-rs) | Experimental Rust wrapper for iceoryx | Rust |
| [IceRay](https://github.com/elBoberido/iceray) | An iceoryx instrospection client written in Rust | Rust |

Is something missing or you've got ideas for other nifty examples? Jump right away to the next section!

## Maintainers
## Governance & maintainers

An up to date list of the maintainers can be found at the [Eclipse project page](https://projects.eclipse.org/projects/technology.iceoryx/who).
Please have a look at the [GOVERNANCE.md](./GOVERNANCE.md).

0 comments on commit dd8a786

Please sign in to comment.