Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
55 lines (35 loc) · 1.63 KB

CONTRIBUTING.md

File metadata and controls

55 lines (35 loc) · 1.63 KB

Welcome to the contributing guide

The vidkarya project has two separate repos for its Website:

  1. Frontend
  2. Backend

Project Setup

  1. Fork the repo you want to contribute to.
  2. Run the following commands:
$ git clone https://github.com/<your-username>/<forked-repo-name>
$ cd <forked-repo-name>
$ npm install
  1. Start the server.
Frontend:
$ npm start

Backend:
$ nodemon server.js

Guidelines 📜

  1. Before working on any new fix/feature/update, make sure you create an issue with appropriate title and description. Then get yourself assigned to start contributing.

  2. Always create your separate branch for contribution. Branch name must be in the format: "YourName/featureName"

for eg. if your name is John & you're working on profile page, branch name should be "john/profilePage"

  1. Write clean and readable code, add comments, linespaces wherever required.

  2. Avoid making unnecessary changes (e.g., extra whitespace or formatting) unrelated to your current feature/fix/update.

  3. Use a consistent commit message format:

Examples:

  • fix: Navbar alignment
  • add: Blog Page
  • update: Navbar

  1. When you raise a PR, please make sure that you mention #issue (issue number) in PR description.

  2. Ensure that at least one maintainer reviews the PR. They will merge it once it meets all requirements.


Note: Please maintain professionalism in all communications, including comments and PR discussions. Avoid vulgarity, and ensure respectful interactions.