Home
Welcome to the ime-api wiki! We're excited that you're interested in contributing. This guide will help you get started with contributing to our open-source project.
The IME API project is an open-source initiative aimed at providing a simple and efficient way to access a vast collection of quiz questions. Our API is used by various applications, including educational apps, trivia games, and more.
We welcome contributions from developers like you to help improve and expand our API. Whether you're interested in fixing bugs, adding new features, improving documentation, or anything else, your contributions are highly appreciated.
Before you start contributing, there are a few things you need to do:
- Fork the Repository: Click the "Fork" button at the top right of our GitHub repository.
-
Clone the Repository: Clone your forked repository to your local machine using
git clone. - Install Dependencies: Ensure you have all the necessary dependencies installed as mentioned in the project's TOML.
- Create a Branch: Create a new branch for your contribution. Naming your branch according to the type of contribution is a good practice (e.g., feature/add-pagination).
- Make Changes: Make your desired changes in your local branch.
- Test Your Changes: Test your changes locally to ensure they work as expected.
- Commit Changes: Commit your changes with a clear and concise commit message.
- Push Changes: Push your changes to your forked repository.
- Create a Pull Request (PR): Open a PR from your forked repository to the main repository. Be sure to provide a clear description of your changes in the PR.
- Review and Iterate: Participate in the code review process, address feedback, and iterate on your changes as needed.
We welcome various types of contributions, including:
- Bug Fixes
- New Features
- Documentation Improvements
- Performance Enhancements
- Code Refactoring
- Test Coverage
Please follow our coding guidelines and ensure that your code is well-documented and tested.
We have a Code of Conduct that we expect all contributors to follow. Please read and adhere to it when participating in our community.
If you encounter any issues while using our API or have suggestions for improvements, please open an issue on our GitHub repository. Contact Us
If you have questions or need assistance with the contribution process, feel free to reach out to us via email or through our community forums.
Thank you for your interest in contributing to the IME API project!