Skip to content

Latest commit

 

History

History
62 lines (40 loc) · 2.02 KB

CONTRIBUTING.md

File metadata and controls

62 lines (40 loc) · 2.02 KB
Raw

CONTRIBUTING

At Monkeys, contributions are always welcome, no matter how large or small.

Communication Style (Recommended)

  1. Always include screenshots for visual changes.
  2. Provide a detailed description in your Pull Request (PR) and follow give format.
  3. Review your code thoroughly, leaving comments where necessary for reviewers.
  4. Maintain active communication in issues and PRs to facilitate collaboration.

Setup

  1. Clone & create this repo locally with the following command:
git clone https://github.com/the-monkeys/the_monkeys.git
  1. Install dependencies using npm:
npm install
# or npm install --force
  1. Copy .env.example to .env.local and update the variables.
cp .env.example .env.local

  1. Input all the required enviroment variables in .env file.

  2. Start the development server:

# At the root of the repo
npm run dev

Pull Requests

We actively welcome your pull requests, however linking your work to an existing issue is preferred.

  1. Fork the repo and create your branch
  2. Name your branch something that is descriptive to the work you are doing. i.e. adds-new-thing.
  3. Make sure you address any lint warnings.
  4. If you make the existing code better, please let us know in your PR description.
  5. A PR description and title are required.

Work in progress

GitHub has support for draft pull requests, which will disable the merge button until the PR is marked as ready for merge.

Issues

If you plan to contribute a change based on an open issue, please assign yourself by commenting on the following word .take. Issues that are not assigned are assumed open, and to avoid conflicts, please assign yourself before beginning work on any issues.

If you would like to contribute to the project for the first time, please consider joining checking the good first issue labels.

Also, all questions are welcomed.