Skip to content

Latest commit

 

History

History
73 lines (45 loc) · 2.36 KB

ContributionGuide.md

File metadata and controls

73 lines (45 loc) · 2.36 KB

Contributing to BooksMall 🎉

Thank you for your interest in contributing to BooksMall! We appreciate your willingness to help improve the project. This document provides guidelines on how to contribute effectively.

How to Contribute

We welcome contributions from everyone! Here's how you can get involved:

1. Fork the Repository

  • Click the "Fork" button at the top right corner of the repository page to create your own copy of the project.

2. Clone Your Fork

Clone your forked repository to your local machine:

git clone https://github.com/Sahil-Gupta584/BooksMall.git
cd BooksMall

3. Create a New Branch

Before making changes, create a new branch to work on:

git checkout -b my-feature-branch

4. Make Your Changes

Make the necessary changes to the code. This could include bug fixes, new features, or improvements to documentation.

5. Commit Your Changes

Once you've made your changes, commit them with a clear and descriptive message:

git add .
git commit -m "Add a descriptive commit message"

6. Push Your Changes

Push your changes back to your forked repository:

git push origin my-feature-branch

7. Create a Pull Request

  • Go to the original repository and click on the "Pull Requests" tab.
  • Click the "New Pull Request" button.
  • Select your branch from the dropdown menu and provide a description of your changes.
  • Submit your pull request!

Guidelines

To maintain a high-quality codebase, please follow these guidelines:

  • Code Style: Ensure your code adheres to the project's coding standards. You can use tools like Prettier or ESLint for consistent formatting.
  • Documentation: If your changes affect how the project works, please update the documentation accordingly.
  • Testing: Ensure that your changes do not break any existing functionality. Write tests for new features whenever possible.
  • Respect Others: Be respectful and considerate towards other contributors and maintainers. We aim to foster a welcoming and inclusive community.

Reporting Issues

If you encounter any bugs or have feature requests, please open an issue in the repository. Provide as much detail as possible, including steps to reproduce the issue.

Thank You!

Your contributions make BooksMall a better project for everyone. We look forward to your pull requests! Happy coding! 🚀