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

CONTRIBUTING.md: Fix link to unit tests #756

Merged
merged 2 commits into from
Apr 13, 2021

Conversation

jonasdn
Copy link
Contributor

@jonasdn jonasdn commented Apr 12, 2021

Fixes: #755

They where moved to repo-docs.

Fixes: bitcraze#755
@krichardsson
Copy link
Contributor

Looking good, but maybe also update the link to "building and flashing instructions" to the same style

There are actually 3 different ways of linking:

  1. to our web - https://www.bitcraze.io/documentation/repository/crazyflie-firmware/master/
  2. to github - https://github.com/bitcraze/crazyflie-firmware/tree/master/docs
  3. to local docs dir - /docs/

For markdown files in the root (usually readme.md and contributing.md) I think 1. is the best option and 2. the worst

To give users a proper styled version.
@jonasdn
Copy link
Contributor Author

jonasdn commented Apr 13, 2021

Looking good, but maybe also update the link to "building and flashing instructions" to the same style

There are actually 3 different ways of linking:

  1. to our web - https://www.bitcraze.io/documentation/repository/crazyflie-firmware/master/
  2. to github - https://github.com/bitcraze/crazyflie-firmware/tree/master/docs
  3. to local docs dir - /docs/

For markdown files in the root (usually readme.md and contributing.md) I think 1. is the best option and 2. the worst

Thanks for review! I've updated building and flashing in the README.md as well.

@krichardsson krichardsson merged commit a2316dc into bitcraze:master Apr 13, 2021
@jonasdn jonasdn added this to the 2021-06-rc1 milestone Jul 1, 2021
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.

Broken link
2 participants