Skip to content

Latest commit

 

History

History
58 lines (37 loc) · 2.44 KB

CONTRIBUTING.md

File metadata and controls

58 lines (37 loc) · 2.44 KB

Contributing to VanillaKit Express

Thank you for considering contributing to VanillaKit Express! We welcome contributions from the community to help improve and expand the project. This guide will help you get started with contributing.

Getting Started

To contribute to VanillaKit Express, follow these steps:

  1. Fork the Repository: Click the "Fork" button on the top right of the project’s GitHub page to create a copy of the repository under your own GitHub account.

  2. Clone Your Fork: Clone the forked repository to your local machine.

    git clone https://github.com/hanzala-h/VanillaKit-Express.git
cd VanillaKit-Express

  3. Install Dependencies: Install the required dependencies for the project.

    npm install

  4. Create a New Branch: Create a new branch for your feature or bugfix.

    git checkout -b your-branch-name

Making Contributions

  1. Code Style: Ensure your code adheres to the project's coding style. Follow the existing code patterns and conventions used in the project.

  2. Testing: If you add new features or fix bugs, make sure to test your changes thoroughly.

  3. Documentation: Update the documentation as needed to reflect your changes. This includes updating the README.md, adding comments to code, or other relevant documentation.

Submitting a Pull Request

  1. Push Your Changes: Push your changes to your forked repository.

    git add .
git commit -m "Describe your changes"
git push origin your-branch-name

  2. Create a Pull Request: Go to the original repository on GitHub and create a pull request from your fork. Provide a clear description of the changes you made, why they are necessary, and any relevant information.

  3. Review and Feedback: Your pull request will be reviewed by the project maintainers. They may request changes or provide feedback. Make sure to address any comments and update your pull request as needed.

  4. Merge: Once approved, your pull request will be merged into the main branch of the repository.

Code of Conduct

Please adhere to our Code of Conduct while participating in this project.

Contact

If you have any questions or need further assistance, please contact the project maintainers through the issues page on GitHub or via email at sayhi.hanzla@gmail.com.

Thank you for contributing to VanillaKit Express!