Skip to content

Latest commit

 

History

History
91 lines (67 loc) · 2.64 KB

contribute.md

File metadata and controls

91 lines (67 loc) · 2.64 KB
Raw

Contributing Guidelines

Thanks for taking the time to contribute!

The following is a set of guidelines for contributing to LIA.

Getting Started

LIA app is built on top of React. If you are new to React, please head over to this great article.

Consider this:

  • Only use NPM (^6.4.1) as package manager.

  • Comment every util’s function and, optionally, comment any behavior that you think needs a documentation using jsdoc's guide (http://usejsdoc.org/index.html).

  • Write descriptive commits for each file you modify, create or delete.

Folder Structure

-file /folder

/lia
  /public
  /build
  /docs
  /src
    /client
      /__tests__ 
        /__snapshots__ 
        -testName.test.js 
      /redux
        -initialState.js
        -actions.js
        /reducers
        /boundedActions 
      /router 
        -index.js 
      /utils 
        -utilName.js 
      /components 
        -componentName.js
    /server
      /config
      /controllers
      /errors
      /models
      /routes
      /utils
    -server.js

Community

  • The whole LIA documentation, such as setting up a development environment, setting up with the LIA webapp project, and testing, can be read here.

  • If you have any questions regarding LIA, open an issue.

Issue

Ensure the bug was not already reported by searching on GitHub under issues. If you're unable to find an open issue addressing the bug, open a new issue.

Please pay attention to the following points while opening an issue.

Write detailed information

Detailed information is very helpful to understand an issue.

Consider providing the following information:

  • How to reproduce the issue step-by-step.
  • The expected behavior (or what is wrong).
  • Screenshots for GUI issues.
  • The application version.
  • The operating system.

Testing

LIA performs Unit Testing for each component and function inside the application in order to ensure code quality and minimize bugs.

The following libraries are used to performs LIA's tests:

  • Jest

  • Enzyme + enzyme-adapter-react-16

Run tests with: npm run test

Pull Requests

Pull Requests are always welcome.

  1. When you edit the code, please run tests to check the formatting of your code before you git commit.
  2. Ensure the PR description clearly describes the problem and solution. It should include:
    • The operating system on which you tested.
    • The relevant issue number, if applicable.