Skip to content
This repository has been archived by the owner on Jan 12, 2023. It is now read-only.

Latest commit

 

History

History
104 lines (72 loc) · 3.22 KB

CONTRIBUTING.md

File metadata and controls

104 lines (72 loc) · 3.22 KB

How Do I Get Started? | Setup | Running Linting/Tests | Build for Production

How Do I Get Started?

destiny-insights-frontend is a React JS web app using web services to collect metrics and display that data on beautiful charts.

Thanks for the interest, really. There are bugs and features in the issues. A good place to start is issues with the beginner-friendly label. I ask that any new features align to the long term vision of the project:

A simple way on any device to quickly see Open Source Software (OSS) contributions, info on how the contributions, and how it impacts the larger OSS community.

Setup

Setup and use requires Git, Node JS, and a text editor such as VS Code.

If you're on a Mac, I'd suggest using Homebrew for installing Node and Git.

Cloning & Dependency Installations

git clone https://github.com/cujarrett/destiny-insights-frontend.git
cd destiny-insights-frontend
npm install

Running Linting/Tests

Run Linting

Finds problematic patterns or code that doesn’t adhere to certain style guidelines.

npm run lint

Fix linting Errors (Where Possible)

npm run fix-lint

Run Tests

Runs the app in the development mode.

npm run test

Start local server to see app during development

The page will reload if you make edits. You will also see any lint errors in the console.

npm run start

Open http://localhost:3000 to view it in the browser.

Build for Production

It correctly bundles React in production mode and optimizes the build for the best performance. The build is minified and the filenames include the hashes.

npm run build

Commit Message Guidelines

This project follows the Conventional Commits specification to aid in automated releases and change log generation. Commitlint is enabled and ran as a commit-msg hook to enforce the commit format. Commitizen can be used to prompt through any requirements at commit time npm run commit (or git cz if Commitizen is installed globally).

In short, if a commit will be fixing a bug, prefix the commit message with fix:

fix: my bug fix
feat: my new feature

Commits with fix: prefix will show up in the generated changelog as bullets under the Bug Fixes: section, and feat: prefixed messages will show under the Features: section. For more on the available prefixes/rules, see here.