Skip to content

Latest commit

 

History

History
69 lines (46 loc) · 3.48 KB

CONTRIBUTING.md

File metadata and controls

69 lines (46 loc) · 3.48 KB
Raw

🎉 Welcome to Create My API! 🎉

Thank you for considering contributing to Create My-API! We’re thrilled to have you here and can’t wait to see what amazing things we can build together. This project aims to accelerate the creation of backend projects, making it effortless to build RESTful APIs with various backend and database technology combinations. Let’s dive in! 🚀

How You Can Contribute

Ready to jump in? Follow these steps to start contributing:

  1. Fork the Repository 🍴

    • Click the "Fork" button at the top of the page to fork the repository to your GitHub account.

  2. Clone Your Fork 🖥️

    • Clone your forked repository to your local machine using: 
      git clone https://github.com/Puskar-Roy/create-my-api

  3. Create a Branch (Mandatory) 🌿

    • It’s mandatory to create a new branch for your changes. Don’t make changes directly to the master branch of your fork. Create a new branch with: 
      git checkout -b feature/your-feature-name

Important Ways to Contribute

Here are some key areas where you can make a difference:

a. Add a New API Template 📄

  • We’re always looking to expand our library of API templates. If you have a cool setup that isn’t currently covered, feel free to create a new template. Ensure your template is well-documented and follows our coding standards.

If you want to add a new API, please place it inside the packages/APIs directory.

b. Enhance Existing Templates ✨

  • See something that could be improved in our existing templates? Whether it’s optimizing code, adding comments, or fixing bugs, we’d love your input. Enhancements can include performance tweaks, better documentation, or any other improvements you can think of.

If you want to enhance existing templates or APIs, please work inside the packages/APIs directories.

c. Work on the Website 🌐

  • Our website helps users understand and use Create My-API. You can contribute by fixing bugs, adding new features, or improving the overall design and user experience. If you’re a frontend whiz, we’d love your help here!

If you want to contribute to the Create-My-API documentation website, please work inside the apps directory. The web subdirectory is for the Next.js frontend and the server subdirectory is for the Node.js Express backend.

  1. Make Your Changes 💻

    • Implement your changes in your new branch. Ensure your code follows the project's coding standards and is well-documented.

  2. Commit and Push 🚢

    • Commit your changes with a clear and descriptive commit message: 
      git commit -m "Description of your changes"
    • Push your changes to your forked repository: 
      git push origin feature/your-feature-name

  3. Create a Pull Request 🔄

    • Head back to the original repository on GitHub and create a pull request from your branch. Provide a detailed description of your changes and why they should be merged.

Code of Conduct ❤️

Please note that this project adheres to a Code of Conduct. By participating, you are expected to uphold this code. If you notice any unacceptable behavior, please report it to the project maintainers.

Thank you for your contributions and for helping to make Create My-API better! We’re excited to see what you come up with.

Contact 📬

If you have any questions, feel free to open an issue or reach out to the project maintainers.

Happy coding! ✨