| ... | ... | @@ -2,21 +2,25 @@ |
|
|
|
|
|
|
|
## Contributing
|
|
|
|
|
|
|
|
- [Contributing](Contributing)
|
|
|
|
* [Create and handle forks](https://gitlab.eclipse.org/groups/eclipse/aidge/-/wikis/Create-a-fork-of-the-main-repositories)
|
|
|
|
* [Link SSH key gitlab eclipse](Link%20SSH%20key%20gitlab%20eclipse)
|
|
|
|
* [How to push to a fork as a upstream member](https://docs.gitlab.com/ee/user/project/merge_requests/allow_collaboration.html#push-to-the-fork-as-the-upstream-member)
|
|
|
|
* [Create merge requests](Merge-request-guidelines)
|
|
|
|
* [Review MR](Review-MR)
|
|
|
|
* [List of required tests](Test-list.md)
|
|
|
|
* [Writing documentation](Writing%20documentation)
|
|
|
|
* [Creating a release](release)
|
|
|
|
### Newcomers
|
|
|
|
|
|
|
|
### Gitflow
|
|
|
|
- [Contributing](src/contributing/newcomers/contributing)
|
|
|
|
- [Create and handle forks](src/contributing/newcomers/create_a_fork_of_the_main_repositories)
|
|
|
|
- [Link SSH key gitlab eclipse](src/contributing/newcomers/link_ssh_key_gitlab)
|
|
|
|
- [Create merge requests](src/contributing/newcomers/merge_request_guidelines)
|
|
|
|
|
|
|
|
#### Templates
|
|
|
|
### Contributors
|
|
|
|
|
|
|
|
- [Release](templates/Release-Notes)
|
|
|
|
- [Development workflow](src/contributing/contributors/development_workflow)
|
|
|
|
- [How to push to a fork as a upstream member](https://docs.gitlab.com/ee/user/project/merge_requests/allow_collaboration.html#push-to-the-fork-as-the-upstream-member)
|
|
|
|
- [Review MR](src/contributing/contributors/review_mr)
|
|
|
|
- [List of required tests](src/contributing/contributors/test_list)
|
|
|
|
- [Writing documentation](src/contributing/contributors/writing_documentation)
|
|
|
|
- [Creating a release](src/contributing/contributors/release)
|
|
|
|
|
|
|
|
### Templates
|
|
|
|
|
|
|
|
- [Release template](templates/Release-Notes)
|
|
|
|
|
|
|
|
## Coding practices
|
|
|
|
|
| ... | ... | @@ -24,42 +28,30 @@ |
|
|
|
|
|
|
|
- [WebKit coding style](https://webkit.org/code-style-guidelines/#names) (Naming convention)
|
|
|
|
- [Google C++ Style Guide](https://google.github.io/styleguide/cppguide.html) (for C++ best practice)
|
|
|
|
- [C++ test](C++%20test)
|
|
|
|
- [C++ test](src/coding_practices/cpp/cpp_test)
|
|
|
|
|
|
|
|
### Python
|
|
|
|
|
|
|
|
- [PEP8 guidelines](https://peps.python.org/pep-0008/)
|
|
|
|
- [Handling python path](python%20path)
|
|
|
|
- [Python test](python%20test)
|
|
|
|
- [Handling python path](src/coding_practices/python/python_path)
|
|
|
|
- [Python test](src/coding_practices/python/python_test)
|
|
|
|
|
|
|
|
### General & Tooling
|
|
|
|
### Tooling
|
|
|
|
|
|
|
|
- [Development workflow](Development%20workflow)
|
|
|
|
- [Get good at git](Get%20good%20at%20git)
|
|
|
|
- [Code formatting and linting](https://gitlab.eclipse.org/groups/eclipse/aidge/-/wikis/code-quality-:-formatting-&-linting)
|
|
|
|
- [Error handling](Error%20handling)
|
|
|
|
- [Guide to properly log](Logging)
|
|
|
|
- [Code formatting and linting](src/coding_practices/tooling/linting)
|
|
|
|
- [Error handling](src/coding_practices/tooling/error_handling)
|
|
|
|
- [Guide to properly log](src/coding_practices/tooling/logging)
|
|
|
|
- [Debugger VSCode](src/coding_practices/tooling/debugger_vscode)
|
|
|
|
|
|
|
|
## Technical specification
|
|
|
|
## Technical specifications
|
|
|
|
|
|
|
|
- [Tensor](Tensor).
|
|
|
|
- [Copy construct an operator](Copy%20construct%20an%20operator).
|
|
|
|
- [Graph Regex](Graph%20regex)
|
|
|
|
- [Tensor](src/technical_specifications/Tensor).
|
|
|
|
- [Copy construct an operator](src/technical_specifications/Copy-construct-an-operator).
|
|
|
|
|
|
|
|
## CI/CD
|
|
|
|
|
|
|
|
- [Understand the CI/CD Pipelines](Understand%20the%20CI%20CD%20Pipelines)
|
|
|
|
- [Setup a Windows OVH instance for CI](Setup%20a%20Windows%20OVH%20instance%20for%20CI)
|
|
|
|
- [Setup an Ubuntu OVH instance for CI](Setup%20an%20Ubuntu%20OVH%20instance%20for%20CI)
|
|
|
|
|
|
|
|
## Tools
|
|
|
|
|
|
|
|
- [Debugger VSCode](Debugger%20VsCode)
|
|
|
|
|
|
|
|
### Export **deprecated**
|
|
|
|
|
|
|
|
- [Add Arm-CortexM operator](https://gitlab.eclipse.org/groups/eclipse/aidge/-/wikis/Add-Arm-CortexM-operator)
|
|
|
|
|
|
|
|
## Team organization **deprecated**
|
|
|
|
- [Understand the CI/CD Pipelines](src/ci_cd/Understand%20the%20CI%20CD%20Pipelines)
|
|
|
|
- [Setup a Windows OVH instance for CI](src/ci_cd/Setup%20a%20Windows%20OVH%20instance%20for%20CI)
|
|
|
|
- [Setup an Ubuntu OVH instance for CI](src/ci_cd/Setup%20an%20Ubuntu%20OVH%20instance%20for%20CI)
|
|
|
|
|
|
|
|
- [What is SCRUM and how do we use it ?](What%20is%20SCRUM%20&%20how%20we%20use%20it) |
