Skip to content

Latest commit

 

History

History
55 lines (38 loc) · 4.75 KB

CONTRIBUTING.md

File metadata and controls

55 lines (38 loc) · 4.75 KB
Raw

Contributing to missioncontrol

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 missioncontrol functionality came from pull requests sent by the developer community. Here is how you can contribute too:

  • Fork the repository from the missioncontrol GitHub page.
  • Clone a copy to your local machine with $ git clone [email protected]:YOUR-GITHUB-USER-NAME/missioncontrol.git
  • Based on your platform install docker for:
  • In the console run docker network create dav. This simply creates a link between different docker projects, allowing them to communicate (similar to a symlink).
  • In the missioncontrol directory, run docker-compose build && docker-compose up. If at any time you stop this process, you can start it again by running docker-compose build && docker-compose up again.
  • At this point you might consider also setting up the Missions project. This is the client side app that interacts with Mission Control.
  • Code, code, code.
  • Before committing your code, stop docker and run npm test to make sure all the automated tests still pass
  • 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/missioncontrol) 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 references that issue (just include the issue number in the title like this: #49)

Important:

  • To get the full multimedia-🚢🚠🚗🚕🚅-experience, you might want to also run missions in another terminal window. See the missions instructions for help
  • 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 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 missioncontrol, 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 many details as possible.

Explain the problem and include additional details to help maintainers reproduce the problem.

  • 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.