Skip to content

Latest commit

 

History

History
41 lines (27 loc) · 2.81 KB

CONTRIBUTING.md

File metadata and controls

41 lines (27 loc) · 2.81 KB
Raw

Contributions

This is a quick guide on how to contribute to XBOS and where code contributions should go.

Prerequisites

  • Create a free GitHub account
  • Install Git on your computer
    • do this through your favorite package manager if you are familiar with command-line interfaces
    • OR, install the GitHub desktop application (Mac OS X or Windoze), which has helpful documentation. Don't forget to set it up

Setting up your copy

Collaboration happens by making edits to your own "fork" of the XBOS project; when your changes are ready for others to use or test, you can submit a "pull request". This section discusses how to set up the fork the first time. This only needs to be done once.

  1. Begin by forking the XBOS project by clicking the "Fork" button in the top-right. This will create a copy of the project under your own account. You can make changes to this copy without affecting the main XBOS project.
  2. Clone the new project under your account

Organizing Stuff

The XBOS project has several folders used to organize its various components. Depending on what you are contributing, it should go in a different folder.

  • apps/: contains end-use applications for doing control, analysis, etc.
  • dashboards/: contains code for user-facing dashboards
  • services/: contains code for applications that are used by other applications

If you are unsure where something should go, just ask!

Contributing

After making your edits on your local copy, go through a quick checklist:

  • have you written documentation on how your code works and how it is intended to be used?
    • this can be done in a README.md file
  • if you are contributing Python code, have you included a requirements.txt file containing the dependencies?
  • make sure you remove all passwords, usernames, IP addresses and other identifying information for the systems you are developing against

Commit your changes to your local repo (desktop instructions), and then file a pull request (desktop instructions).