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.

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

Docs: Documentation updates #1257

Merged
merged 50 commits into from
Sep 20, 2022
Merged

Docs: Documentation updates #1257

merged 50 commits into from
Sep 20, 2022

Conversation

isabelle-dr
Copy link
Contributor

@isabelle-dr isabelle-dr commented Sep 16, 2022

Summary:

This PR contains various updates to the documentation.
It replaces PR #1234 and #1252
It closes issues #1175, #1225, #1150, #1178
Overview:

  • added two images showing the PR process and a decision tree "what to do with the acceptance test result" in CONTRIBUTING.md so that contributors know what to expect
  • created new issue templates, using GitHub forms, and a link to the slack channel in the "new issue" page
  • a few aesthetic changes in README.md
  • typos in README.md and RULES.md
  • updated RELEASE.md with naming the artefacts and added the new step in the wiki

Expected behavior:

An improved documentation, better issue templates

Please make sure these boxes are checked before submitting your pull request - thanks!

  • [ ] Run the unit tests with gradle test to make sure you didn't break anything
  • Format the title like "feat: [new feature short description]". The title must follow the Conventional Commit Specification(https://www.conventionalcommits.org/en/v1.0.0/).
  • Linked all relevant issues
  • [ ] Include screenshot(s) showing how this pull request works and fixes the issue(s)

README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@emmambd emmambd left a comment

Choose a reason for hiding this comment

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

This looks great @isabelle-dr! I had 2 minor comments.

.github/ISSUE_TEMPLATE/bug_report.yml Outdated Show resolved Hide resolved
docs/ACCEPTANCE_TESTS.md Show resolved Hide resolved
Copy link
Collaborator

@bdferris-v2 bdferris-v2 left a comment

Choose a reason for hiding this comment

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

Small nits aside, LGTM

@isabelle-dr
Copy link
Contributor Author

Thanks for the comments Brian and Emma 🙏.
Merging this PR

@isabelle-dr isabelle-dr merged commit 9c41c25 into MobilityData:master Sep 20, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants