Skip to content

Latest commit

 

History

History
81 lines (67 loc) · 2.77 KB

contributing.md

File metadata and controls

81 lines (67 loc) · 2.77 KB
Raw

Contributors Guide for ElectroKart⚡

Welcome to ElectroKart! Make sure to star this repository😍
We appreciate your interest in contributing.😊
This guide will help you get started with the project and make your first contribution.

Prerequisites 📋

Before getting started, ensure you have the following tools installed:

  • Node.js (version >= 14.x)
  • npm (version >= 6.x)

You can check if Node.js and npm are installed by running:

node -v
npm -v

Creating Your First Pull Request 🌟

1. Star this repository: Show some love by starring the repository!

2. Fork this repository: Click the 'Fork' button at the top right of this page to create a copy of this repository in your account.

3. Clone the forked repository:

git clone https://github.com/<your-github-username>/ElectroKart.git

4. Navigate to the project directory

cd ElectroKart

5. Install the dependencies:

npm install

6. Create a new branch (use descriptive branch names

feature/<feature_name> or fix/<issue_name>):

git checkout -b feature/<your_branch_name>

7. Make changes and ensure the app runs correctly:

npm start

8. Stage your changes and commit (use descriptive commit messages like

feat: added new feature or fix: corrected issue):

git add .
git commit -m "feat: added new feature"

9. Push your local commits to the remote repository:

## git push -u origin feature/<your_branch_name>

10. Create a Pull Request (PR):

Provide a detailed description of the changes you've made.
If it's a UI change, consider adding screenshots for better understanding.

11. Congratulations! 🎉 You've made your contribution.

Pull Request Review Criteria 🧲

  1. Please fill out the PR template properly when creating a pull request.
  2. Assign yourself to the issue you’re working on to help us track progress.
  3. Never commit to the main branch.
  4. Your work must be original and adhere to the project's coding standards.
  5. Comment your code where necessary for clarity.
  6. Always ensure all tests pass before pushing your changes by running:
npm run test

Communication and Support 💬

  1. Join the project's communication channels to interact with other contributors and seek assistance.
  2. If you have any questions or need help, don't hesitate to ask in the project's communication channels or comment on the relevant issue.

Code of Conduct 😇

Please follow our project's code of conduct while contributing. Treat all contributors and users with respect, and create a positive and inclusive environment for everyone.

License 📄

The project is licensed under MIT. Make sure to review and comply with the license terms.