Skip to content

Latest commit

 

History

History
35 lines (22 loc) · 2.78 KB

contributing.md

File metadata and controls

35 lines (22 loc) · 2.78 KB

Contributing Guide 🤝

Thank you for your interest in contributing to this project! Your help is greatly appreciated. Here's how you can get involved:

How to Contribute 🚀

  1. Fork the Repository 🍴: Click the "Fork" button at the top right of the repository page to create your own copy of the repository under your GitHub account.
  2. Create a New Branch 🌿: Use the command git checkout -b feature-branch to create a new branch for your changes. Use descriptive names for your branches to make it clear what you're working on.
  3. Make Your Changes ✍️: Work on your changes in the new branch. Make sure to follow the project's coding standards and include comments to explain your code.
  4. Submit a Pull Request 🔄: When you're ready, push your branch to your forked repository and open a pull request to the main repository. Include a clear description of what you've changed and why.

For more detailed instructions, check out GitHub's guide on creating a pull request.

Development Setup 🛠️

To get your development environment ready, follow these steps:

  1. Install Node.js and npm: Make sure you have Node.js and npm installed. You can download them from the official Node.js website.
  2. Clone the Repository: Use git clone <repository-url> to get a copy of the project on your local machine.
  3. Install Dependencies: Navigate to the project directory and run npm install to install all necessary dependencies.
  4. Start the Development Server: Run npm run dev to start the server and see your changes live.

Code Quality 🧹

To keep the code clean and maintainable, please:

  1. Follow Coding Standards: Stick to the coding guidelines provided in the repository. This includes consistent formatting, meaningful names, and clear comments.
  2. Run Tests: Before submitting your pull request, run npm test to make sure all tests pass. Testing ensures that your changes don't break the project.
  3. Use Linters: Utilize tools like ESLint to catch potential issues and enforce coding standards. Follow the ESLint Getting Started guide to set it up.

Reporting Issues 🐛

If you encounter any bugs or issues, please report them in the issue tracker. Include as much detail as possible, such as steps to reproduce, expected outcomes, and any relevant screenshots or logs.

For tips on writing good bug reports, refer to GitHub's Mastering Issues guide.