Skip to content

Latest commit

 

History

History
143 lines (89 loc) · 5.61 KB

Contribution.md

File metadata and controls

143 lines (89 loc) · 5.61 KB

Contributing to ShopCart 🎉

Thank you for considering contributing to ShopCart! We welcome all contributions, whether you're fixing bugs, optimizing functionalities, or adding new features. To help you get started, we've outlined the process for contributing to the project.

Star our Repository ⭐

Stars Forks Issues PRs Open PRs Closed


Need Help With The Basics? 🤔

If you're new to Git and GitHub, no worries! Here are some useful resources:

Contribution Guidelines 📚

  • Follow the coding standards and guidelines.
  • Write meaningful commit messages.
  • Ensure your changes do not introduce breaking bugs.
  • Be responsive to feedback and comments from the project maintainers.
  • Respect deadlines and guidelines in case you're working as part of a program.

We appreciate your contributions and look forward to collaborating with you to make ShopCart better!


First Pull Request ✨

  1. Star this repository Click on the top right corner marked as Stars at last.

  2. Fork this repository Click on the top right corner marked as Fork at second last.

  3. Clone the forked repository

git clone https://github.com/<your-github-username>/ShopCart-E-CommerceWebsite.git
  1. Navigate to the project directory
cd ShopCart-E-CommerceWebsite
  1. Create a new branch
git checkout -b <your_branch_name>
  1. To make changes
git add .
  1. Now to commit
git commit -m "add comment according to your change"
  1. Push your local commits to the remote repository
git push -u origin <your_branch_name>

  1. Create a Pull Request

  2. Congratulations! 🎉 you've made your contribution


Good Coding Practices 🧑‍💻

  1. Follow the Project's Code Style

    • Maintain consistency with the existing code style (indentation, spacing, comments).
    • Use meaningful and descriptive names for variables, functions, and classes.
    • Keep functions short and focused on a single task.
    • Avoid hardcoding values; instead, use constants or configuration files when possible.

  2. Write Clear and Concise Comments

    • Use comments to explain why you did something, not just what you did.
    • Avoid unnecessary comments that state the obvious.
    • Document complex logic and functions with brief explanations to help others understand your thought -process.

  3. Keep Code DRY (Don't Repeat Yourself)

    • Avoid duplicating code. Reuse functions, methods, and components whenever possible.
    • If you find yourself copying and pasting code, consider creating a new function or component.

  4. Code Reviews and Feedback

    • Be open to receiving constructive feedback from other contributors.
    • Conduct code reviews for others and provide meaningful suggestions to improve the code.
    • Always refactor your code based on feedback to meet the project's standards.

Pull Request Process 🚀

When submitting a pull request, please adhere to the following:

  1. Self-review your code before submission. 😀
  2. Include a detailed description of the functionality you’ve added or modified.
  3. Comment your code, especially in complex sections, to aid understanding.
  4. Add relevant screenshots to assist in the review process.
  5. Submit your PR in proper format and hang tight; we'll review it as soon as possible! 🚀

Issue Report Process 📌

To report an issue, follow these steps:

  1. Navigate to the project's issues section :- Issues
  2. Please kindly choose the appropriate template according to your issue.
  3. Provide a clear and concise description of the issue.
  4. Wait until someone looks into your report.
  5. Begin working on the issue only after you have been assigned to it. 🚀

Thank you for contributing

We truly appreciate your time and effort to help improve our project. Feel free to reach out if you have any questions or need guidance. Happy coding! 🚀