Skip to content
This repository has been archived by the owner on Dec 23, 2022. It is now read-only.

Latest commit

 

History

History
64 lines (55 loc) · 2.5 KB

CONTRIBUTING.md

File metadata and controls

64 lines (55 loc) · 2.5 KB

Contributing

Welcome to Trellis, a simplified Trello clone built with React, Redux, Node, Express and MongoDB. The following guidelines will give you a short overview of how we handle issues and PRs in this repository.

We appreciate all valuable contributions - bug reports, documentation and design enhancements, issues as well as Pull Requests to make Trellis more convenient, functional and bug free.

To begin contributing have a look at the open issues here.

Development Setup

  1. Clone the repository
git clone https://github.com/ayushagg31/Trellis.git
cd Trellis
  1. Install dependencies
npm i && cd client && npm i
  1. Create .env file
REACT_APP_CLIENT_KEY="YOUR API KEY" // Unsplash API Key
  1. Create dev.env for development and test.env for testing purpose
cd ../config
(
echo PORT=1313
echo DATABASE_URL="MongoDB Connection String"
echo JWT_SECRET="YOUR JWT TOKEN"
echo NODE_ENV=development
) > dev.env
  1. Go into client/package.json and replace proxy with your server port
"proxy": "http://localhost:1313"
  1. Run the project
npm run trellis

Creating Issues

  • Provide detailed description about the issue and mark it with the relevant labels.
  • If it's a bug, provide steps to reproduce the bug. If possible suggest the ways to resolve it.
  • If it's a feature request, share your thoughts about the final outcome.
  • Don't create duplicate issues, checkout the issue section before reporting it.

Submitting Pull Requests

  • Request assignment to the issue before working
  • Provide the reference to the issue, for which pull request is created
  • Provide detailed description about the changes you have made and the expected outcome, feel free to share images/gif for the outcome.
  • Don't submit independent PR's. First create issue, once approved, submit your PR.
  • Don't submit un-linted code, read instructions for linting below.

Assigning issues

  • Only start working on issues, once assigned by the maintainers.
  • Don't request assignment on more than one issue at a time.
  • ❗ Please provide progress update after a week, if you're not working on the issue, request to unassign.
  • ❗ Issues will be unassigned, if there's no activity/updates from the assignee within a week.

How to Lint and Format code

  • If you are making changes in frontend (client directory), run npm run format to format the code.
  • If you are making changes in backend, run npm run lint:fix to lint the code.