|
|
How to contribute
|
|
|
=================
|
|
|
|
|
|
**You can contribute to AF3 in several ways:**
|
|
|
|
|
|
- submit a [bug
|
|
|
report](https://af3-developer.fortiss.org/projects/af3-phoenix-release/issues)
|
|
|
(and … even better a patch :-))
|
|
|
- [provide us AF3-example
|
|
|
models](https://af3.fortiss.org/about-us/team/)
|
|
|
- [submit showcases done with
|
|
|
AF3](https://af3.fortiss.org/about-us/team/)
|
|
|
- submit a [change
|
|
|
request](https://af3-developer.fortiss.org/projects/af3-phoenix-release/issues)
|
|
|
(and … even better the change itself :-))
|
|
|
- help us to
|
|
|
[develop](https://af3-developer.fortiss.org/projects/autofocus3/wiki/New_developer_-_Step_by_step)
|
|
|
the AF3 base platform
|
|
|
- extend AF3 with [new
|
|
|
plugins](https://af3-developer.fortiss.org/projects/autofocus3/wiki/New_developer_-_Step_by_step)
|
|
|
- … or give us any [feedback](https://af3.fortiss.org/about-us/team/)
|
|
|
(positive of negative)
|
|
|
|
|
|
New developer - Step by step
|
|
|
============================
|
|
|
|
|
|
1\. Get familiar with the software from the perspective of the user:
|
|
|
|
|
|
- browse the AF3 website (http://af3.fortiss.org/)
|
|
|
- run AF3, play with it
|
|
|
- open the examples (available through the menu of AF3)
|
|
|
- look at the help (available through the menu of AF3)
|
|
|
|
|
|
2\. It is now time to build a model on your own:
|
|
|
|
|
|
- Let us study the alternating bit protocol http://en.wikipedia.org/wiki/Alternating\_bit\_protocol
|
|
|
- Then implement an AF3 model for the sender and the receiver components for this protocol with direct communication
|
|
|
channels between the two (in other words no message can be lost during the transmission).
|
|
|
- After having a suitable simulation of this system, replace the direct channels with intermediate media components and implement a lossy behavior, i.e. messages can get lost during transmission.
|
|
|
- Again, validate the proper functioning of the model by simulation.
|
|
|
|
|
|
|
|
|
3\. Set up AF3 development environment
|
|
|
|
|
|
- Set up a development eclipse according to the Developer Installation
|
|
|
|
|
|
4\. Familiarize yourself with the [AF3 Development Workflow](Development_Workflow.md). There, you will learn to update your workspace, how to create and contribute changes, and how to perform code reviews.
|
|
|
|
|
|
5\. read the following code guidelines: [Checklist for code reviews](Check-list\_for\_Code\_Reviews.md)
|
|
|
(you probably won’t understand everything since many things require to be familiar with the code in AF3, but still good to browse to get an idea)
|
|
|
|
|
|
6\. read the following issue reporting guidelines: [Check-list\_for\_New\_Issues](Check-list\_for\_New\_Issues.md)
|
|
|
We are using the [gitlab issue tracking](https://git.fortiss.org/af3/af3/-/issues) You can quickly browse it just to get familiar with it.
|
|
|
|
|
|
7\. You will now be done with the general AF3 developer general knowledge,
|
|
|
the following sections focus more on particular aspects of AF3.
|
|
|
This depends on what your topic and is therefore to be advised by your
|
|
|
supervisor. |
|
|
\ No newline at end of file |