Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
48 lines (34 loc) · 1.84 KB

CONTRIBUTING.md

File metadata and controls

48 lines (34 loc) · 1.84 KB

Contributing to Micro Web Projects

Thank you for considering contributing to the Micro Web Projects repository! We welcome contributions from everyone to help improve and expand this collection of small web projects.

How to Contribute

  1. Fork the repository: Click the "Fork" button at the top-right of the repository to create your own copy of the project.

  2. Clone your fork: Clone your forked repository to your local machine to start working.

    git clone https://github.com/jovdim/Micro-Projects-Collection.git

  3. Create a new branch: Always create a new branch off of the dev branch before making changes.

    git checkout -b your-branch-name dev

  4. Make your changes:

    • If you're adding a new application, create a new folder for it, and include all the necessary files (HTML, CSS, JS).
    • Make sure to include a preview image you can call it "preview-image" showing what the application looks like. This image should be stored inside of you main folder
    • If you're fixing a bug, be sure to address the specific issue and ensure everything works correctly after the fix.

  5. Commit your changes:

    • For new applications or features, use the following commit message format: 
      feat: add (name of the app)
    • For bug fixes, use: 
      fix: resolve issue with (brief description of the bug)
    • Always write clear and descriptive commit messages.

  6. Push your changes: Push your changes back to your forked repository.

    git push origin your-branch-name

  7. Open a Pull Request: Open a Pull Request (PR) from your branch to the dev branch of the main repository. Happy contributing!

We appreciate your contribution and look forward to reviewing your work! Thank you for contributing!