Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
53 lines (38 loc) · 2.38 KB

CONTRIBUTING.md

File metadata and controls

53 lines (38 loc) · 2.38 KB

Contributing to Quiz Genius

Thank you for your interest in contributing to Quiz Genius! We welcome all types of contributions, whether it's bug reports, feature requests, or code enhancements. Please follow the guidelines below to help make the process as smooth as possible.

How to Contribute

Reporting Bugs and Requesting Features

If you encounter any issues or have ideas to enhance the app, please open an issue on GitHub. When reporting bugs, provide:

  • A clear and concise description of the issue.
  • Steps to reproduce the issue.
  • Any relevant logs, screenshots, or examples.

For feature requests, explain the idea and why you think it would be beneficial.

Code Contributions

We encourage contributions that help improve the app’s functionality, fix bugs, or enhance the user experience. To submit code changes, please follow these steps:

  1. Fork the repository: Create a personal copy of the repository on GitHub.
  2. Clone the repository: Download the forked repository to your machine by running: 
    git clone https://github.com/yourusername/Quiz-Genius.git

Note

Note that you should change the text yourusername to your actual username on Github

  1. Create a new branch: 
    git checkout -b your-branch-name
  2. Make your changes: Implement your feature, bug fix, or improvement. Please ensure your code follows the Flutter style guide.
  3. Test thoroughly: Verify your changes locally to ensure they work as intended.
  4. Commit your changes: Use clear and meaningful commit messages: 
    git commit -m "Description of your changes"
  5. Push your changes: 
    git push origin your-branch-name
  6. Submit a pull request: Open a pull request from your branch to the main branch of the original repository. Provide a detailed description of your changes.

Code Review

Your pull request will go through a review process where maintainers may ask for further changes or clarifications. Be sure to respond to feedback and update your pull request accordingly.

Style Guidelines

Please ensure that all contributions follow the Flutter style guide. Consistency in code style helps maintain the quality and readability of the project.