Improve documentation and guidelines (#186)

## Summary
This patch aims to improve documentation and guidelines for newcomers.
It also updates issue and PR templates.

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

Signed-off-by: Nahuel Espinosa <[email protected]>
Co-authored-by: Michel Hidalgo <[email protected]>
Co-authored-by: Gerardo Puga <[email protected]>

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,36 +1,30 @@
 ---
 name: Bug Report
-about: Report a bug in beluga.
+about: Create a report to help us improve.
 title: ''
 labels: bug
 
 ---
 
-## Required info
-- Version or commit hash:
-  - <!-- Output of git rev-parse HEAD or release version  -->
-
-## Steps to reproduce issue
-<!--
-Detailed instructions on how to reliably reproduce this issue.
-Try to share a minimum reproducible example, see http://sscce.org/.
--->
-
-## Expected behavior
-<!--
-What are you expecting as a result of the above steps.
--->
-
-## Actual behavior
-<!--
-What is actually happening when the steps are followed.
-If your program crashes unexpectedly, hangs, etc, please use the debugger to share a traceback.
--->
-
-## Additional information
-<!--
-Here you can add:
-- Permalinks to a related code snippet https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-a-permanent-link-to-a-code-snippet
-- The version or PR where the failure was introduced.
-- Other relevant info not in the above categories.
--->
+### Bug description
+_A clear and concise description of what the bug is._
+
+
+**Platform (please complete the following information):**
+ - OS: [e.g. Ubuntu Focal]
+ - `Beluga` version: [e.g. tag, commit sha]
+
+### How to reproduce
+_List steps to reproduce the issue:_
+1. ...
+
+_Code snippets or minimal examples are always helpful, if not necessary._
+
+**Expected behavior**
+_A clear and concise description of what you expected to happen._
+
+**Actual behavior**
+_A clear and concise description of what actually happened._
+
+### Additional context
+_Any other information you think could be meaningful to this issue._

.github/ISSUE_TEMPLATE/documentation_issue_report.md

@@ -1,28 +1,13 @@
 ---
 name: Documentation Issue Report
-about: Report a documentation issue, typographical error or missing content in beluga.
+about: Report a documentation issue, typographical error or missing content in this repository.
 title: ''
 labels: [bug, documentation]
 
 ---
 
-## Required info
-- Version or commit hash:
-  - <!-- Output of git rev-parse HEAD or release version  -->
+### Issue description
+_A clear and concise description of what the bug is (e.g a typographical error, incorrect documentation, missing content)._
 
-## Description
-<!--
-Description of what the error consists of, it could be a typographical error,
-incorrect documentation, missing content, etc.
-
-Important: If you're trying to report a functional bug, open a Bug Report instead
-(see https://github.com/Ekumen-OS/beluga/issues/new/choose).
--->
-
-## Additional information
-<!--
-Here you can add:
-- Permalinks to a related code snippet https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-a-permanent-link-to-a-code-snippet
-- Relevant bibliographic references.
-- Other relevant info not in the above categories.
--->
+### Additional context
+_Any other information you think could be meaningful to this issue._

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,22 +1,16 @@
 ---
 name: Feature Request
-about: Request a new feature for beluga.
+about: Suggest an idea for a new feature.
 title: ''
 labels: enhancement
+assignees: ''
 
 ---
 
-## Description
-<!--
-Description of what the feature consists of and what problem it will solve.
--->
+### Feature description
 
-## Definition of done
-<!--
-Preferedly, use a task list here.
--->
+_A clear and concise description of the feature, as well as to why it is relevant (e.g. the problem it solves, the use cases it supports, how it improves usability, etc.)_.
 
-## Additional considerations
-<!--
-Alternatives, potential issues, etc.
--->
+### Implementation considerations
+
+_Any special considerations meaningful when implementing this feature._

.github/pull_request_template.md

@@ -1,26 +1,25 @@
-<!--
-Add link to the connected issue.
-If this PR closes the issue, use:
+### Proposed changes
 
-Fixes #<NUMBER>
+_Describe the big picture of your changes here to communicate to the maintainers why we should accept this pull request.
+If it fixes a bug or resolves a feature request, be sure to link to that issue._
 
-If not, use (or similar):
+#### Type of change
 
-Related to #<NUMBER>
--->
+- [ ] 🐛 Bugfix (change which fixes an issue)
+- [ ] 🚀 Feature (change which adds functionality)
+- [ ] 📚 Documentation (change which fixes or extends documentation)
 
-## Summary
-<!--
-For bugs, describe how this PR solves the issue, how to check if it's fixed, etc.
-For features request, describe shortly what's this solving.
+💥 **Breaking change!** _Explain why a non-backwards compatible change is necessary or remove this line entirely if not applicable._
 
-NOTE: The larger description should be done in the linked issue, not here.
--->
+### Checklist
 
-## Checklist
-- [ ] Read the [contributing guidelines](https://github.com/Ekumen-OS/beluga/blob/main/CONTRIBUTING.md).
-- [ ] 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.
+_Put an `x` in the boxes that apply. This is simply a reminder of what we will require before merging your code._
+
+- [ ] Lint and unit tests (if any) pass locally with my changes
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] I have added necessary documentation (if appropriate)
+- [ ] All commmits have been signed for [DCO](https://developercertificate.org/)
+
+### Additional comments
+
+_Anything worth mentioning to the reviewers._

.gitignore

@@ -0,0 +1,8 @@
+# Colcon build
+build/
+install/
+logs/
+
+# Development environments
+.vscode/
+.idea/