Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
123 lines (81 loc) · 2.9 KB

CONTRIBUTING.md

File metadata and controls

123 lines (81 loc) · 2.9 KB

Contributing to MERN Dev Toolkit

Thank you for your interest in contributing to MERN Dev Toolkit! 🎉 This project is open-source, and contributions are welcome from developers of all levels.

By contributing, you help other MERN developers save time and build production-grade applications faster.

📌 Ways to Contribute

You can contribute in several ways:

  1. Add new guides or tutorials

    • New package setup instructions
    • Deployment guides
    • Payment integration examples

  2. Improve existing content

    • Fix typos or grammar
    • Update outdated instructions
    • Optimize code examples

  3. Submit bug fixes

    • Correct errors in markdown files
    • Improve readability or structure

  4. Suggest features or enhancements

    • New diagrams (system design, repo structure)
    • Workflow improvements
    • Additional tech stack recommendations

🛠 How to Contribute

Follow these steps to make a contribution:

Step 1: Fork the Repository

Click the Fork button on the top right of this repository to create your own copy.

Step 2: Clone Your Fork

Clone the forked repository to your local machine:

git clone https://github.com/your-username/mern-dev-toolkit.git

Step 3: Create a New Branch

Create a branch for your feature or fix:

git checkout -b feature/my-new-guide

Step 4: Make Your Changes

  • Add new files or edit existing ones
  • Follow the existing folder and file structure
  • Keep markdown files clear and concise
  • Use proper code formatting for code blocks

Step 5: Commit Your Changes

Commit your changes with a clear and concise message:

git add .
git commit -m "Add guide for integrating Stripe payments"

Step 6: Push to Your Fork

git push origin feature/my-new-guide

Step 7: Create a Pull Request (PR)

  • Go to your fork on GitHub
  • Click Compare & pull request
  • Provide a clear description of your changes
  • Submit the PR

✅ Contribution Guidelines

  • Follow the existing folder structure
  • Ensure all code examples are tested
  • Maintain consistent formatting
  • Keep content clear and beginner-friendly
  • Do not add unrelated content
  • Respect open-source community standards

🧹 Style Guide

  • Use Markdown headings properly (#, ##, ###)
  • Use fenced code blocks for code snippets (js, bash)
  • Add explanations for all code examples
  • Avoid long paragraphs; break content into sections
  • Add images or diagrams if they improve clarity

🌟 Additional Notes

  • Contributions will be reviewed by the maintainers
  • Be patient; PRs may take some time to merge
  • All contributions should aim to help MERN developers learn or build faster

💖 Thank You!

Your contributions make MERN Dev Toolkit better for everyone!

Happy coding 🚀