Skip to content

Latest commit

 

History

History
101 lines (79 loc) · 3.43 KB

CONTRIBUTING.md

File metadata and controls

101 lines (79 loc) · 3.43 KB

Contributing to csi-cli

😄 Thanks for contributing to csi-cli! 😄

csi-cli

The following is a set of guidelines for contributing to csi-cli. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Table of Contents

  1. Styleguides
  2. What should I know before I get started?
  3. How Can I contribute?

Guidelines

The following are the guidelines we request you to follow in order to contribute to csi-cli.

Styleguides

Commit Messages

The commit messages should follow the following pattern:

update: Description # if a feature is updated or enchanced
feat: Description # if a new feature is added
fix: Description # if a bug is fixed

Issues

Note: Please don't file an issue to ask a question.

update: Description # if an update is required for a feature
bug: Description # if there is a bug in a particular feature
suggestion: Description # if you want to suggest a better way to implement a feature

Code Styleguide

Javascript

The following are the guidelines for Javascript code.

  • Names of the variables and routes should be self-explanatory.
  • Well formatted and indented code.
  • Comment lines wherever required.
  • Preferably use async await.
  • Should follow the specified structure in structure.md

Python

Please follow the following guidelines for Python code.

  • Names of variables and routes should be self-explanatory.
  • Comment lines wherever required.
  • Add a requirements.txt if any new packages are included.
  • Should follow the structure mentioned in structure.md

Bash

Bash code should be written according to the following.

  • Names of variables should be self-explanatory.
  • Well formatted and indented code.
  • Comment lines wherever required.
  • Should not affect the structure of the code already written.

C/C++

Readability of code can be enhanced by the following:

  • Names of variables should be self-explanatory.
  • Comment lines wherever needed.

HTML and CSS

HTML and CSS code should be written keeping in mind the following:

  • The new html pages must follow the same theme. If a new theme is suggested, it must contain all html pages.
  • Prefer classes over ids, make the code as general and scalable as possible.
  • Class-names and ID names should explain what they are for.
  • Well indented code with comment lines.

Pull Requests

Pull requests should have:

  • A concise commit message.
  • A description of what was changed/added.

What should I know before I get started

You can contribute to any of the features you want by knowing atleast one of the following:

  • Python - Django Framework
  • Node-js - Express-js Framework
  • Bash (For Unix like Systems and/or new Windows terminal)
  • C/C++ (For Windows)
  • HTML and CSS - For Frontend Code
  • Markdown - To contribute to any of the .md files.

How Can I Contribute

You can contribute by:

  • Reporting Bugs
  • Suggesting Enhancements
  • Code contribution
  • Pull Requests

Please follow the guidelines mentioned above for contribution

Contributors - Hacktoberfest 2k19

Add your name to the list below, and send a PR

Name Github profile
Rohan Mukherjee roerohan