Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
45 lines (31 loc) · 1.59 KB

CONTRIBUTING.md

File metadata and controls

45 lines (31 loc) · 1.59 KB

How to Contribute

  1. Fork the repository
  2. Clone the repository to your local machine
  3. Create a new branch
 git checkout -b <branch-name>
  1. Make your changes
  2. Commit and push your changes
 git add .
 git commit -m "commit message"
 git push origin <branch-name>
  1. Create a pull request
  2. Wait for the pull request to be reviewed and merged

How to Setup Environment Variables

Duplicate and rename the file .env.example to .env.local and fill in the values.

Just you need to add only DEV_GITHUB_TOKEN in .env.local file.

GitHub Token

  1. Go to GitHub Settings -> Developer Settings -> Personal Access Tokens -> Token (classic) -> Generate new token image
  2. Give the repo permission, add token name and copy the token and paste in .env.local file.

Setup GitHub OAuth App (Optional)

  1. Go to GitHub Developer Settings -> OAuth Apps -> New OAuth App image

  2. You have to create a new OAuth App and fill in the values as shown in the image below. image

  3. Now you have to copy CLIENT ID & CLIENT SECRETS and paste in .env.local file. Group 1

Note: Client ID goes to GITHUB_ID and Client SECRETS goes into GITHUB_SECRET.