First off, thank you for considering contributing to our Decentralized AI Agent for Polymarket! It's contributors like you that help make this project a powerful tool for prediction markets.
Following these guidelines shows that you respect the time and effort of the developers working on this project. In return, we’ll address your contributions efficiently, review your changes, and help you finalize your pull requests.
We value all kinds of contributions! Whether it’s improving our documentation, triaging bugs, or enhancing our algorithms, your contributions are greatly appreciated.
This project is open source, and we’re thrilled to receive contributions from the community. You can help by writing tutorials, reporting bugs, suggesting new features, or contributing code to improve our AI agent.
To streamline the process, please avoid these types of contributions:
Please do not use the issue tracker for general support questions. For help, consider joining our the Polymarket Discord or referring to the Polymarket API documentation.
We ask that all contributors adhere to the following standards:
Responsibilities
- Ensure compatibility with multiple environments where our AI agent operates.
- Create issues for significant changes and gather community feedback.
- Keep changes modular and focused.
- Foster an inclusive environment and welcome contributors from diverse backgrounds.
New to contributing? Here’s how you can start:
Begin by exploring our beginner-friendly issues, which are tagged as good first issue. These are smaller tasks that are great for newcomers.
Here are some tutorials to guide you through your first open source contribution:
New to open source? Check out How to Contribute to an Open Source Project on GitHub.
At this point, you're ready to make your changes! Feel free to ask for help; everyone is a beginner at first 😸
If a maintainer asks you to "rebase" your PR, they're saying that a lot of code has changed, and that you need to update your branch so it's easier to merge.
Follow these steps to submit your contributions:
- Fork the repository and make changes in your fork.
- Ensure your code follows our style guide and passes all tests.
- Sign the Contributor License Agreement (CLA), if required.
- Submit a pull request with a detailed description of your changes.
For significant changes:
- Fork the repo and make your changes.
- Ensure your changes align with the project’s coding standards.
- Sign the Contributor License Agreement if applicable.
- Open a pull request and describe the changes you’ve made.
For minor fixes, such as typos or documentation improvements, you can:
Submit a simple patch without a CLA if the change does not involve significant new functionality. Examples include:
- Typographical corrections
- Simple formatting changes
- Non-functional code adjustments
If you discover a security issue, please report it privately:
If you find a security vulnerability, do NOT open an issue. Instead, email Polymarket directly.
When reporting a bug, please provide the following details:
When filing a bug, include:
- The version of the AI agent you are using.
- Your operating system and environment.
- Steps to reproduce the issue.
- Expected behavior.
- Actual behavior observed.
Before suggesting a feature, understand our project goals:
Our AI agent aims to leverage decentralized mechanisms to provide accurate predictions within Polymarket's markets. We are focused on enhancing market analysis and prediction accuracy.
If you have an idea for a new feature:
Open an issue on GitHub with a detailed description of the feature, including its purpose, benefits, and any proposed implementation details.
Our review process is as follows:
The core team must approve the PR.