Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
88 lines (53 loc) · 3.49 KB

CONTRIBUTING.md

File metadata and controls

88 lines (53 loc) · 3.49 KB

Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make will benefit everybody else and are greatly appreciated. If you're on the 100Devs team and are interested in contributing to this project, you may reach out via Discord:

GarlandKey bananasplitlady

Development environment setup

Prerequisites

This repository requires the use of npm. You can find installation instructions here.

Installation

To install the required packages & dependencies:

npm i

Usage

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in your browser.

The page will reload when you make changes.
You may also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

npm run build

Builds the app for production to the build folder.
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.
Your app is ready to be deployed!

See the section about deployment for more information.


Commiting Code

When leaving commits, please give a detailed description of what changes were made and where.

git commit -m "Author: ..." -m "Date: ..." -m "Description: ..."


Branch naming & pull requests

This repo is set up to not allow any commits to be pushed directly to the main or dev branches.

Create a new branch using the format YourUserName/very-short-description. When you're ready to submit a pull request, you will want to merge it in to dev. Ideally, this pull request will correspond with one or more Issues.

We will submit pull requests from dev to main when we have enough meaningful changes committed.


Issues and feature requests

You've found a bug in the source code, a mistake in the documentation or maybe you'd like a new feature? You can help us by submitting an issue on GitHub. Before you create an issue, make sure to search the issue archive -- your issue may have already been addressed!

Please try to create bug reports that are:

  • Reproducible. Include steps to reproduce the problem.
  • Specific. Include as much detail as possible: which version, what environment, etc.
  • Unique. Do not duplicate existing opened issues.
  • Scoped to a Single Bug. One bug per report.

Even better: Submit a pull request with a fix or new feature!

How to submit a Pull Request

  1. Search our repository for open or closed Pull Requests that relate to your submission. You don't want to duplicate effort.
  2. Fork the project
  3. Create your feature branch (git checkout -b feat/amazing_feature)
  4. Commit your changes (git commit -m 'feat: add amazing_feature')
  5. Push to the branch (git push origin feat/amazing_feature)
  6. Open a Pull Request