Skip to content

Latest commit

 

History

History
85 lines (55 loc) · 2.32 KB

CONTRIBUTING.md

File metadata and controls

85 lines (55 loc) · 2.32 KB

Contributing to CIMS, The open source Cloud Inventory Managenment System.

Table of Contents

License

This software is written under the GPL V3 license. This software is free to be run, modified, distributed, etc free of charge in accordence to the license.

How to Setup Your Development Environment

Prerequisites

  • NPM: Linux Command sudo apt-get install npm
  • Node.js: Linux Command sudo apt-get install nodejs

Fork Project

Fork the project into your repositories, this will allow you to commit your changes.

Download Repository

You can either do this through a Github GUI like Github Desktop or GitKraken or you can do it through the terminal using git clone https://github.com/YOUR-USERNAME/CIMS

Install Repository

Navigate to your new working directory in your terminal and type npm install. This will download any prerequisites and change any project settings needed to be able to run on your system.

Start Environment

Navigate to your working directory in your terminal and type npm start. This will start the development server on your system, this server will automatically rerender any changes once you save a file.

How to Contribute Code

Finding Issues

Code Standard

Pull Request

Copyright and Licensing

Code Styling

CSS Style

Javascript Style

Copyright

Issue Styling

Technical Information

Labelling

Projects

Milestones

Asignees

Other Ways of Contributing

Bug Hunting

Issue Maintainer

Wiki Writer