Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
60 lines (37 loc) · 2.26 KB

CONTRIBUTING.md

File metadata and controls

60 lines (37 loc) · 2.26 KB

Contributing to Project

First off, thanks for taking the time to contribute!

The following is a set of guidelines for contributing to Project and its packages, which are hosted in the Link on GitHub. 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

Code of Conduct

What should I know before I get started?

  • This project is built on Flask framework [A python based framework for hosting dynamic websites] and uses React.js to render the visually appealing Front-End.

Styleguides

Code of Conduct

This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior.

What should I know before I get started?

Branch

  • Please fork the repository and create a branch for any new bug or features.

Comments

  • Whenever a new file is created or any existing file is updated, please add necessary and meaningful comments

Update README file and requirements.txt files regularly

  • Please ensure that the readme file and requirements.txt are updated when ever you make significant change or make use of new packages.

You are contributing to this repository which is under Apache License: 🏅

Refer LICENSE for more information

Styleguides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally after the first line

Documentation Styleguide

Troubleshoting

  • Installation errors:
    Front End:
    cd FrontEnd
    delete node-modules
    npm install
    npm start