Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
92 lines (59 loc) · 2.73 KB

CONTRIBUTING.md

File metadata and controls

92 lines (59 loc) · 2.73 KB

Contributing to VissiPass

Thank you for considering contributing to VissiPass! We welcome contributions that improve the project, whether through bug fixes, new features, documentation updates, or any other improvements.

Please follow the guidelines below to contribute to this project.

Getting Started

  1. Fork the repository:
    Click on the "Fork" button at the top of this repository to create a copy under your GitHub account.

  2. Clone your forked repository:

    git clone https://github.com/khushalsarode/appwrite-hackathon.git
cd appwrite-hackathon

  3. Create a new branch for your changes:

    git checkout -b feature/your-feature-name

Making Changes

  • Ensure that your code adheres to the project's existing coding style and conventions.
  • If you’re adding a new feature or modifying existing functionality, consider adding relevant tests.
  • Make sure to update or add documentation for any new features or changes to existing functionality.

Commit Guidelines

  • Use clear and concise commit messages that explain what and why rather than how.

  • Use the following format for your commit message:

    [Feature | Fix | Refactor | Docs] Short description of the change

    Example:

    [Fix] Resolve visitor pass generation bug in the Admin module

Pull Request Process

  1. Push your changes to your branch:

    git push origin feature/your-feature-name

  2. Open a Pull Request in the main repository:

    • Go to the original repository on GitHub and click on the "Pull Request" tab.
    • Click "New Pull Request" and select the branch you’ve worked on.
    • Ensure your pull request has a clear title and description, explaining your changes and why they should be merged.

  3. Review Process:

    • A project maintainer will review your pull request and may suggest changes or improvements.
    • Once approved, your pull request will be merged.

Reporting Issues

If you find a bug, have a question, or want to suggest a feature, feel free to open an issue.

When reporting issues:

  • Be clear and descriptive.
  • Include steps to reproduce if applicable.
  • Provide any relevant logs, error messages, or screenshots.

Code of Conduct

Please note that this project adheres to a Code of Conduct. By participating, you agree to uphold this code.

Thank you for helping make VissiPass better for everyone! 🎉

Replace <your-username> and <repo-owner> with the actual GitHub usernames. This template covers the essential aspects for contributors and sets a welcoming tone for future collaborators.