Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add an overview of contribution guidelines (#43)
* docs: copy documents from Autoware.Auto Reorganize documentation structure Signed-off-by: Geoffrey Biggs <[email protected]> [#499] Adding note in developers guide about double-star syntax. Squashed 'src/external/mpc/' changes from 8fc7cfdd..eaa5908b eaa5908b Merge branch 'input-weight-modify' into 'master' b9ee8e4f Update default mpc_controller_node parameters 8d15f49d Add weights to acceleration and steer controls; loosen simulation test case: git-subtree-dir: src/external/mpc git-subtree-split: eaa5908bdd987051a9dcd9c505f99bfd7f028547 unify coverage instructions Add design doc for autoware_auto_create_pkg Resolve "Remove Atom from ADE" Squashed 'src/external/autoware_auto_msgs/' changes from 56550efd..f40970ea f40970ea Adding velocity_mps to VehicleControlCommand. git-subtree-dir: src/external/autoware_auto_msgs git-subtree-split: f40970ead34d36a695b432dc37accff9d67c17e2 Resolve "Add Notes about Doc Format to Contribution Guide" [!801] Expand contributor guidelines and associated documents - Explain stable links and polish documentation.md - Synchronize links from merge request template to contributor guide - Update coverage, unit test, integration test commands - Remove short paragraphs about unit and integration test from contributer guidelines because there are dedicated sections for that - Add images to show how to find coverage report in CI - Require first commit to have proper message - rewrote "how to run exectable" section because it wasn't rendered nicely Move/retitle a few files Reorganize building & other sections Reviewer comments [!821] Fix numerours code highlighting and markup issues, add TOCs - TOC still missing on design docs [!835] Add AVP instructions to docs Other improvements of the docs include - table-of-contents generation fixed - replace links to external markdown files with HTML. Not sure why doxygen doesn't complain in CI, it failed with version 1.8.13 in my ADE - spell checking of numerous documents - remove subtree doc [#912] Make code snippet blocks consistent in documentation [#924] Use `#` in commit msg tag - Update prepare-commit-msg git hook - update MR templates - update contributor guidelines [#813] use autoware_set_compile_options() for nearly all compiled tests - fix a few causes of warnings and disable warning flags as needed for other tests - set CXX_STANDARD strictly and only in a single place - add CMake flag `AUTOWARE_OPTIMIZATION_OF_SLOW_TARGETS`. Default: OFF - update building instructions and MR template - fix nasty initialization error of static constexpr member in `GenericState` of Kalman filter [#954] Clarify copyright notice [1007] Fix up Doxygen format to work around old Doxygen version failing to link to .md files [#920] Add changes for review workflow [#949] Update docs on integration testing [!960] Remove rtd workarounds [#1012] Update contributor guidelines with merge-bot info [#1109] Explain merge bot and MR title in MR templates [#1319] Add a .clang-format file to Project Root * update documents Signed-off-by: Kenji Miyake <[email protected]> * update documents Signed-off-by: Kenji Miyake <[email protected]> * update Signed-off-by: Kenji Miyake <[email protected]> * Update docs/contributing/index.md Co-authored-by: M. Fatih Cırıt <[email protected]> * Update docs/contributing/index.md Co-authored-by: M. Fatih Cırıt <[email protected]> * Update docs/contributing/index.md Co-authored-by: M. Fatih Cırıt <[email protected]> * Update docs/contributing/index.md Co-authored-by: M. Fatih Cırıt <[email protected]> * Update docs/contributing/index.md Co-authored-by: M. Fatih Cırıt <[email protected]> * Update docs/contributing/index.md Co-authored-by: M. Fatih Cırıt <[email protected]> * Update docs/contributing/index.md Co-authored-by: M. Fatih Cırıt <[email protected]> * Update docs/contributing/index.md Co-authored-by: M. Fatih Cırıt <[email protected]> Co-authored-by: Geoffrey Biggs <[email protected]> Co-authored-by: Keisuke Shima <[email protected]> Co-authored-by: M. Fatih Cırıt <[email protected]>
- Loading branch information