Skip to content

Latest commit

 

History

History
65 lines (37 loc) · 2.9 KB

Contributing.md

File metadata and controls

65 lines (37 loc) · 2.9 KB
Raw

Contributing to Chaty

Thank you for considering contributing to QuickLink! We welcome contributions from the community to help improve and grow our app. By contributing, you can make a positive impact on the user experience and add new features to benefit all users.

Ways to Contribute

There are several ways you can contribute to Chaty:

  1. Code Contributions: If you have coding skills, you can help us by fixing bugs, implementing new features, and improving existing functionalities. You can do this by submitting pull requests with your changes.

  2. Documentation: Clear and comprehensive documentation is essential for the success of any project. If you find areas that need better documentation or you would like to add more explanations, feel free to contribute.

  3. Testing: Testing is crucial to ensure the reliability and stability of the app. You can contribute by testing new features, verifying bug fixes, and reporting any issues you encounter.

  4. Feedback and Suggestions: Providing feedback and suggestions for improvements is highly valuable. You can share your thoughts on how to enhance the app or make it more user-friendly.

Getting Started

To get started with contributing to Chaty, follow these steps:

  1. Fork the repository to your GitHub account.

  2. Clone your forked repository to your local machine:

    git clone https://github.com/JaeAeich/QuickLink.git

  3. Create a new branch for your contribution:

    git checkout -b feature/your-contribution

  4. Make your changes and improvements to the code or documentation.

  5. Test your changes thoroughly to ensure they work as expected.

  6. Commit your changes with clear and descriptive commit messages (please use convensional commit):

    git commit -m "Add your commit message here"

  7. Push your changes to your forked repository:

    git push origin feature/your-contribution

  8. Create a pull request (PR) from your branch to the main repository's main branch. Include a detailed description of your changes in the PR.

Code Style

To maintain consistency and readability, we follow a coding style. Please ensure your code adheres to the existing style and use appropriate naming conventions.

Code Review

Every contribution will undergo code review. Feedback may be provided to ensure the code meets the project's standards. Please be open to feedback and be willing to make necessary changes.

License

By contributing to Chaty, you agree that your contributions will be licensed under the project's LICENSE file.

Thank you for your interest in contributing to Chaty! Your support and collaboration are instrumental in making this app a better and more enjoyable platform for all users. If you have any questions or need assistance with your contribution, feel free to reach out to us. Happy coding!