Skip to content

Update contributions section with how to set up a dev environment #149

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

Merged
merged 5 commits into from
Jun 10, 2015

Conversation

hamishwillee
Copy link
Contributor

This splits "Contributing" out into its own section and splits up the original docs appropriately. It adds instructions on how to set up dev environment using Linux/Vagrant. This is appropriate because we are now getting more interest and contributions, and we need to make it easier for people to contribute.

All the instructions are significantly updated:

  • I reduced Daniel's Linux instructions to reference the existing wiki document (which gets updated by the ArduPilot team). This also fixes some limitations with the original doc like the fact that it is Copter-specific.
  • I added a very brief style-guide to the documentation section.

I think this is good, but I will need to re-read it tomorrow. At the moment I am too close to the text and would not see defects.

@djnugent
Copy link

djnugent commented Jun 5, 2015

@hamishwillee I don't know how you replied to a specific part of my comment, but I exclusively use "-w" and have no problems. Looking at sim_vehicle.sh it appears "-w" pulls from the same location. https://github.com/diydrones/ardupilot/blob/master/Tools/autotest/sim_vehicle.sh#L367

@hamishwillee
Copy link
Contributor Author

@djnugent You're right - excellent. I mostly use Ramon's vagrant startup script and that ignores the -w command. I'll fix this up.

@djnugent
Copy link

djnugent commented Jun 5, 2015

@hamishwillee I think the reason Ramon doesn't use "-w" is because he starts SITL using a different script than sim_vehicle.sh. However, both do the same thing!

@hamishwillee
Copy link
Contributor Author

@djnugent In theory yes. But testing shows that the -w option doesn't work using his script. I haven't attempted to debug but I added an issue mrpollo/sitl-vagrant-recipe#1

@hamishwillee
Copy link
Contributor Author

@djnugent As we briefly discussed last night, I had an epiphany - the only difference between developing using DK vs developing for DK is that when you're modifying DK itself you need to rebuild your own fork of DK. Thats a very small delta against the instructions in the Quick Start and Getting Started.

So I've cut out all the stuff in the contributions on setting up SITL etc and simply recommended first following Quick Start/Getting started, and then explained how to fork and build DK on top of that for each of the platforms. It is much simpler and more modular.

Can you please check you're OK with this?

@djnugent
Copy link

djnugent commented Jun 5, 2015

Exactly! That is the only difference. It looks much better! I like the titling better too. "Setting up DroneKit-Python for Development on Linux" was kind of confusing. That was the question I had about wordage last night

@hamishwillee
Copy link
Contributor Author

@djnugent Thanks Daniel (and yes, the naming was "clunky"). @mrpollo - probably good to take this in now.

mrpollo added a commit that referenced this pull request Jun 10, 2015
Update contributions section with how to set up a dev environment
@mrpollo mrpollo merged commit dbcb5a1 into dronekit:master Jun 10, 2015
@mrpollo
Copy link
Member

mrpollo commented Jun 10, 2015

@hamishwillee @djnugent thanks guys!

@hamishwillee hamishwillee deleted the tmp_contributing_updates branch June 10, 2015 04:38
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.

3 participants