Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve documentation and guidelines #186

Merged
merged 15 commits into from
May 18, 2023
Merged

Improve documentation and guidelines #186

merged 15 commits into from
May 18, 2023

Conversation

nahueespinosa
Copy link
Member

@nahueespinosa nahueespinosa commented May 13, 2023 •
edited
Loading

Summary

This patch aims to improve documentation and guidelines for newcomers.
It also updates issue and PR templates to achieve consistency with LAMBKIN.

  • Add README.md files for all packages
  • Update contributing guidelines
  • Update issue and PR templates
  • Add top-level gitignore file

This is not intended to be a finished job, but rather an improvement on the current state.

Checklist

  • Read the contributing guidelines.
  • Configured pre-commit and ran colcon test locally.
  • Signed all commits for DCO.
  • Added tests (regression tests for bugs, coverage of new code for features).
  • Updated documentation (as needed).
  • Checked that CI is passing.

@nahueespinosa nahueespinosa added documentation Improvements or additions to documentation enhancement New feature or request labels May 13, 2023
@nahueespinosa nahueespinosa requested a review from hidmic May 13, 2023 19:52
@nahueespinosa nahueespinosa self-assigned this May 13, 2023
@nahueespinosa nahueespinosa force-pushed the nahuel/docs branch 5 times, most recently from ecd22a8 to b39b7a2 Compare May 14, 2023 15:18
hidmic
hidmic reviewed May 14, 2023
View reviewed changes
Copy link
Collaborator

@hidmic hidmic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

First pass. It looks great @nahueespinosa. I wonder if it would also make sense to address some of the pain points that #176 brought up.

CONTRIBUTING.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
beluga_amcl/README.md Outdated Show resolved Hide resolved
beluga_amcl/README.md Outdated Show resolved Hide resolved
beluga_amcl/README.md Outdated Show resolved Hide resolved
beluga_amcl/README.md Outdated Show resolved Hide resolved
beluga_amcl/README.md Outdated Show resolved Hide resolved
@nahueespinosa nahueespinosa force-pushed the nahuel/docs branch 2 times, most recently from 0d60226 to 881237d Compare May 14, 2023 19:38
@nahueespinosa nahueespinosa requested a review from hidmic May 14, 2023 19:40
@nahueespinosa
Copy link
Member Author

I wonder if it would also make sense to address some of the pain points that #176 brought up.

@hidmic I just posted my thoughts here #176 (comment).

@glpuga
Copy link
Collaborator

glpuga commented May 15, 2023 •
edited
Loading

JIC: I created some diagrams for the INNOVAR application. Let me know if you want to reuse some of the images for this purpose, I've got the SVG files.

00 - concepto general
01 - diferentes configuraciones
02 - extensibilidad
catalog

@nahueespinosa
Copy link
Member Author

@glpuga Nice! I think we can add one of those to the README, can you send me the files?

@glpuga
Copy link
Collaborator

glpuga commented May 16, 2023

A version addressing your comments and equalizing puzzle piece sizes. Notice I added the a frame again because in dark mode otherwise all the dark fames and leters become lost in the background. I made other versions too. I'll upload them tomorrow to the shared folder.

github6

nahueespinosa and others added 3 commits May 15, 2023 21:51
@nahueespinosa
Improve documentation and guidelines
e4a50ad 
Signed-off-by: Nahuel Espinosa <nespinosa@ekumenlabs.com>
@nahueespinosa @hidmic
Address code review comments
96f95b6 
Signed-off-by: Nahuel Espinosa <nespinosa@ekumenlabs.com>
Co-authored-by: Michel Hidalgo <michel@ekumenlabs.com>
@nahueespinosa @glpuga
Add diagram
ed27eaf 
Signed-off-by: Nahuel Espinosa <nespinosa@ekumenlabs.com>
Co-authored-by: Gerardo Puga <glpuga@ekumenlabs.com>
@nahueespinosa nahueespinosa requested review from glpuga and removed request for hidmic May 16, 2023 00:53
@nahueespinosa
Re-upload video
971e32d 
Signed-off-by: Nahuel Espinosa <nespinosa@ekumenlabs.com>
@nahueespinosa
Re-upload diagram
6c193e1 
Signed-off-by: Nahuel Espinosa <nespinosa@ekumenlabs.com>
glpuga
glpuga reviewed May 16, 2023
View reviewed changes
Copy link
Collaborator

@glpuga glpuga left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A quick pass.

.github/ISSUE_TEMPLATE/bug_report.md Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug_report.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/documentation_issue_report.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/feature_request.md Outdated Show resolved Hide resolved
.github/pull_request_template.md Show resolved Hide resolved
GETTING_STARTED.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
beluga_amcl/README.md Outdated Show resolved Hide resolved
nahueespinosa and others added 4 commits May 16, 2023 20:38
@nahueespinosa @glpuga
Apply suggestions from code review
5700816 
Co-authored-by: Gerardo Puga <glpuga@gmail.com>
Signed-off-by: Nahuel Espinosa <nespinosa@ekumenlabs.com>
@nahueespinosa
Reword feature request description
066a6e9 
Signed-off-by: Nahuel Espinosa <nespinosa@ekumenlabs.com>
@nahueespinosa
Fixed instead of implemented
d4b65fc 
Signed-off-by: Nahuel Espinosa <nespinosa@ekumenlabs.com>
@nahueespinosa
Reword test coverage sentence
d2d26f6 
Signed-off-by: Nahuel Espinosa <nespinosa@ekumenlabs.com>
@nahueespinosa
Remove sentence
f835651 
Signed-off-by: Nahuel Espinosa <nespinosa@ekumenlabs.com>
@nahueespinosa
Reword branch instruction
81912e0 
Signed-off-by: Nahuel Espinosa <nespinosa@ekumenlabs.com>
@nahueespinosa
Copy link
Member Author

@glpuga Thanks for your review! I think this is ready for another pass.

@nahueespinosa nahueespinosa requested a review from glpuga May 17, 2023 01:29
@nahueespinosa
Rewrite contributing instructions
5d1f4de 
Signed-off-by: Nahuel Espinosa <nespinosa@ekumenlabs.com>
@nahueespinosa
Reword to semi-automated
04c9e52 
Signed-off-by: Nahuel Espinosa <nespinosa@ekumenlabs.com>
@nahueespinosa
Rewrite AMCL readme
f81d88d 
Signed-off-by: Nahuel Espinosa <nespinosa@ekumenlabs.com>
@nahueespinosa
Copy link
Member Author

@glpuga Re-requesting review!

@glpuga
Copy link
Collaborator

glpuga commented May 17, 2023

@glpuga Re-requesting review!

Got it, I'll take a look in the evening.

glpuga
glpuga previously approved these changes May 17, 2023
View reviewed changes
Copy link
Collaborator

@glpuga glpuga left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Final comments, but overall LGTM, great work!

CONTRIBUTING.md Outdated Show resolved Hide resolved
beluga_amcl/README.md Show resolved Hide resolved
.github/pull_request_template.md Show resolved Hide resolved
@nahueespinosa
Reword and fix punctuation
88b19ea 
Signed-off-by: Nahuel Espinosa <nespinosa@ekumenlabs.com>
@nahueespinosa nahueespinosa requested a review from glpuga May 18, 2023 02:34
@nahueespinosa nahueespinosa merged commit 47a7772 into main May 18, 2023
@nahueespinosa nahueespinosa deleted the nahuel/docs branch May 18, 2023 13:49
@nahueespinosa nahueespinosa mentioned this pull request May 24, 2023
Merged
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hidmic hidmic hidmic left review comments

@glpuga glpuga glpuga approved these changes

Assignees

@nahueespinosa nahueespinosa

Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@nahueespinosa @glpuga @hidmic