Skip to content

Latest commit

 

History

History
72 lines (44 loc) · 2.56 KB

CONTRIBUTING.md

File metadata and controls

72 lines (44 loc) · 2.56 KB
Raw

🚀 Contributing to "You Don't Need JavaScript" 🌐

Thank you for considering lending your expertise to the "You Don't Need JavaScript" project. Your contributions play a vital role in enhancing this resource for developers who wish to craft web features sans JavaScript. Welcome aboard!

Let's navigate through these guidelines for a smooth and collaborative contribution process.

How to Contribute

🙌 We're all for contributions, be it bug fixes, feature upgrades, or the introduction of new demos. To get started, follow these steps:

  1. Fork the Repository:

    • Hit that "Fork" button at the top of this repository.

  2. Clone Your Fork:

    • Bring the repository to your local machine with this command: 
      git clone https://github.com/your-username/You-Dont-Need-JavaScript.git

  3. Create a New Branch:

    • Forge a new branch for your contribution with a name that paints a picture, e.g., feature/my-new-demo. 
      git checkout -b feature/my-new-demo

  4. Make Your Changes:

    • Work your magic and make the desired changes or additions to the project.

  5. Test Your Changes:

    • Cast a spell of testing to ensure your changes function correctly without introducing any gremlins.

  6. Add Your Work to README:

    • Weave your masterpiece into the README.md following our Style Guide.

  7. Commit Your Changes:

  • Contribute with meaningful commits that tell the story of your work.

    git commit -m "Add a new demo for XYZ feature"

  1. Push to Your Fork:

    • Send your enchanting changes to your fork on GitHub.

      git push origin feature/my-new-demo

  2. Create a Pull Request (PR):

    • Journey to the original repository on GitHub and invoke the "New Pull Request" button.

    • Craft a clear and concise title and description for your PR.

    • Unveil your PR for the grand review.

  3. Review and Collaboration:

  • Join the maintainers in an epic collaboration, addressing feedback or requested changes.

  1. Your PR is Merged:

    • Once your PR is approved and merged, your contribution shall be immortalized within the project.

Code of Conduct 🤝

Please be aware that we uphold a Code of Conduct to ensure a positive and respectful environment for all contributors. As a participant in this project, you pledge to abide by the Code of Conduct.

Let's embark on this collective journey to create a precious resource for developers. Thank you for adding your spark to "You Don't Need JavaScript!" ⚡🌟