Skip to content

Latest commit

 

History

History
95 lines (61 loc) · 3.59 KB

CONTRIBUTING.md

File metadata and controls

95 lines (61 loc) · 3.59 KB

Contributing

Welcome to OpInCo-Community/OpInCo-Page! Before sending your pull requests, make sure that you read the guidelines carefully. If you have any doubt on the contributing guide, please feel free state it clearly and discuss with the community.

How to Contribute - Installation Guide

Before getting started let's install the project on your system!!

1. 🔨 Setup & Run

Visit our GitHub repository and click on the Fork option in the top right corner of your GitHub account. This creates a copy of the repository.

2. Clone the repository

git clone command creates a copy/clone of the repository in you local system.

--> You can clone this repo by using the below command and navigate to the directory.

git clone https://github.com/<YOUR_USERNAME>/OpInCo-Page.git
cd OpInCo-Page

3. Setup Remote

git remote add upstream https://github.com/OpInCo-Page/OpInCo-Page.git

4. Sync your fork or your local repository with the origin repository

git checkout main
git fetch upstream
git merge upstream/main

5. Set-up the requisite Tech Stack.

Intro : This is a Next.js project bootstrapped with create-next-app.

To Get Started. First, run the development server:

npm run dev
    OR
yarn dev

Open http://localhost:3000 with your browser to see the result. You can start editing the page by modifying pages/index.tsx. The page auto-updates as you edit the file.

API routes can be accessed on http://localhost:3000/api/hello. This endpoint can be edited in pages/api/hello.ts. The pages/api directory is mapped to /api/*. Files in this directory are treated as API routes instead of React pages.

Learn More

To learn more about Next.js, take a look at the following resources:

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js. Check out our Next.js deployment documentation for more details.

6. Create a PR

After you are done making all the requisite changes. Push your changes to the repository and create a good PR. To do so go through the Contributing Guidelines

Contributing Guidelines

It is requested of you that -

  1. Start working on the pull request if and only if you are assigned the complimentary issue.
  2. Create good and valuable PR. Go through the Code of Conduct and follow the PR template to avoid spam PR's.

PR Review

Your PR will get reviewed soon. If the maintainers suggest changes, do all the changes, commit the changes, rebase the branch, squash the commits and push the changes. If everything looks good, your PR will be merged. That's it! Thank you for your contribution!

All the best! 🥇