Page author: @tallenet @pierregaillard @lsoulier @cmoineau @gregkub
Get involved !
The Eclipse AIDGE is an Eclipse Community project so it obeys governance rules described in the Eclipse Development Process to guarantee meritocracry, vendor-neutrality and business-friendliness.
- Get involved !
- License
- Gitlab eclipse account
- Issues
- Contribution via forks
- Commit Recommendations
- Merge request
- Development Conventions and Guidelines
License
If this is your first time contributing to an Eclipse Foundation project, you'll need to sign the Eclipse Contributor Agreement. For more information, please see the Eclipse Committer Handbook or the FAQ.
- Create an account on dev.eclipse.org
- Read and sign the Eclipse Contributor Agreement
Gitlab eclipse account
Your eclipse account is linked to a gitlab eclipse account. We recommand to link a SSH key on your gitlab eclipse account.
Issues
Search the issue tracker for a relevant issue or create a new one. Before reporting an issue, please consider whether the issue still exists or as already been reported.
Contribution via forks
Aidge is an Eclipse project. Because of that and to ensure codebase stability, only certified committers can directly push on official repositories. This title is given to people that have done consistent contribution to the codebase. Meanwhile, new contributors need to contribute via forks. Here is a tutorial to learn how to setup a forked project.
Commit Recommendations
Correctly configure your git
These commands will allow to avoid creating merge commits when pulling from upstream.
git config pull.rebase true git config pull.ff onlyClean up your branch history before requesting a merge.
A clean commit history is essential to help the work of maintainers, mostly to help them release fix releases.
Hence, before requesting a merge it is required that you clean up your commits. Here are links on how to do that.
Merge request
Wether you are the author or a reviewer of the merge request, you must ensure that the MR guidelines are followed.
Development Conventions and Guidelines
Code linting & formatting
This project uses clang-format & clang-tidy in order to format & lint CXX code as well as Ruff to format python code.
Only formatted code will pass the CI. Hence, non formatted code won't be accepted for review.
A page has been dedicated to help newcomers understand their importance & how to set up these tools.