Skip to content

Latest commit

 

History

History
66 lines (40 loc) · 1.72 KB

CONTRIBUTING.md

File metadata and controls

66 lines (40 loc) · 1.72 KB
Raw

Contributing to Avneesh Sponsors

We are going to create a pr. You need to know basic git and github commands to make a pr. Click on fork in the top left corner of your screen. Clone the repo you have been redirected to

git clone https://github.com/<your_username>/sponsor.git

Installing dependencies

Install yarn globally. This project is using yarn so it is advised to use yarn as package manager.

npm i -g yarn

yarn install

Creating a new branch

git checkout -b <branch-name>

Starting server

yarn dev

Environment Variables

You need the stripe private and public keys in the environment variables. YCreate a .env.local file in the root directory of the project. You can see the env variables needed to be added in .env.sample file.

🛡️ License

This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details.

Committing changes

this project uses conventional commits. You should commit your work according to the conventions. to know more about this, checkout.

Creating a PR

Pushing the code to Github

git add .
git commit -m "commit message (according to conventions mentioned above)"
git push origin new-feature

After pushing the code go to your repository go to your repository and now this button will be enabled.

Now open a pull request.

After clicking on create a pull request, you will see this

Now create a pull request-

  • Give a title and description and create pull request.

  • You have created a pull request, and I will review it soon.