Developer Guide

Thank you for your interest in contributing to our React project! This guide will walk you through the process of making contributions via pull requests (PRs) and ensuring your code adheres to our coding standards. You can refer to this article on how to make a pull request.

Setting up the project

1. Fork https://github.com/ourcodeinc/ActiveDocumentation-webapp repository (Refer to this article on how to fork a repository).
2. Clone the forked project on your system.
3. Navigate to the cloned directory.
4. Install the dependencies by running npm install
5. To start the Project, depending on your operating system, run one of the following commands (See package.json for the details):
   • macOS:

     npm run start-Mac

   • Linux:

     npm run start-Linux

   • Windows:

     npm run start-Windows

Coding Style

We employed ESLint to ensure that submitted code adheres to our coding standards. You can check if your code follows our coding style by running ESLint locally.

• Run ESLint on your code:

  npx eslint .

• Fix any issues reported by ESLint. Some issues can be automatically fixed by running:

  npx eslint . --fix

Code Quality and Best Practices

• Run ESLint: Always run ESLint locally before submitting your PR to ensure your code adheres to our coding standards. Fix any linting errors.
• Avoid Unnecessary Changes: Ensure that your PR only includes relevant changes. Avoid unnecessary modifications such as extra spaces, empty lines, or other formatting changes that do not contribute to the functionality or readability of the code.
• Descriptive Commits: Use descriptive commit messages to explain the purpose of your changes.
• Descriptive PR: Please mention the issue you are fixing in the description of your PR.
• Focused PR: Try to address a single issue in one PR.

Thank you for contributing!