Skip to content

Latest commit

 

History

History
53 lines (36 loc) · 4.75 KB

CONTRIBUTING.md

File metadata and controls

53 lines (36 loc) · 4.75 KB
Raw

Contributing to missions

Thank you for taking the time to lend a hand with the missions project ❤️

There are several ways you can help the project out:

How Can I Contribute?

Contributing Code

A lot of missions functionality came from pull requests sent by the developer community. Here is how you can contribute too:

  • Fork the repository from the missions GitHub page.
  • Clone a copy to your local machine with $ git clone [email protected]:YOUR-GITHUB-USER-NAME/missions.git
  • Run npm install to install all the packages
  • Run npm start to build the project
  • Open http://localhost:3333/ to see your local instance of missions live.
  • If you would like to see some simulated drones appear on the map, you will also need to set up the Mission Control project as well as the Captain-Sim project.
  • To be able to make transactions on ethereum network, you need to set up contracts project, and set the build symlinks at missions/src, to point your build directory at contracts project, with $ ln -sf /path/to/contracts/build /path/to/missions/src/build.
  • Now, code, code, code.
  • Commit your local changes by using $ git commit -m "nice detailed message here..."
  • Once you've made sure all your changes work correctly and have been committed, push your local changes back to github with $ git push -u origin master
  • Visit your fork on GitHub.com (https://github.com/YOUR-USER-NAME/missions) and create a pull request for your changes.
  • Makes sure your pull request describes exactly what you changed and if it relates to an open issue, reference that issue (just include the issue number in the title like this: #49)

Important:

  • This project is just the client-facing side of missions. You can run it on its own and do some limited development, but you won't see any drones on the map, or get any responses to your requests for pickups. To get the full-experience, you will need to also (https://github.com/DAVFoundation/missioncontrol/blob/master/CONTRIBUTING.md) in a separate console window
  • Please stick to the project's existing coding style. Coding styles don't need to have a consensus, they just need to be consistent 😄
  • Push your changes to a topic branch in your fork of the repository. Your branch should be based on the master branch
  • When submitting a pull request, please elaborate as much as possible about the change, your motivation for the change, etc.

Reporting Bugs

Bugs are tracked as GitHub issues. If you found a bug with missions, the quickest way to get help would be to look through existing open and closed GitHub issues. If the issue is already being discussed and hasn't been resolved yet, you can join the discussion and provide details about the problem you are having. If this is a new bug, please open a new issue.

When you are creating a bug report, please include as much detail as possible.

  • Fill in the predefined template provided.
  • Use a clear and descriptive title for the issue to identify the problem.
  • Describe the exact steps which reproduce the problem. Share the relevant code to reproduce the issue if possible.
  • Try to isolate the issue as much as possible, reducing unrelated code until you get to the minimal amount of code in which the bug still reproduces. This is the most important step to help the community solve the issue.

Feature Requests and Ideas

We track discussions of new features, proposed changes, and other ideas as GitHub issues. If you would like to discuss one of those, please first look through existing open and closed GitHub issues and see if there is already a discussion on this topic which you can join. If there isn't, please open a new issue.

When discussing new ideas or proposing changes, please take the time to be as descriptive as possible about the topic at hand. Please take the time to explain the issue you are facing, or the problem you propose to solve in as much detail as possible.