mirror of
https://github.com/BoPeng/ai-marketplace-monitor.git
synced 2025-12-23 22:28:18 -05:00
6b6408b02b
* Switch from poetry to uv * Suppress an info message (close #204) * Fix end of line for markdown files
104 lines
3.5 KiB
Markdown
104 lines
3.5 KiB
Markdown
# Contributing to AI Marketplace Monitor
|
|
|
|
👏🎉 First off all, Thanks for your interest in contributing to our project! 🎉👏
|
|
|
|
The following is a set of guidelines for contributing to AI Marketplace Monitor. These are
|
|
mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
|
|
|
|
## Code of Conduct
|
|
|
|
We take our open source community seriously and hold ourselves and other contributors to high standards of communication. By participating and contributing to this project, you agree to uphold our [Code of Conduct](CODE_OF_CONDUCT.md).
|
|
|
|
## Getting Started
|
|
|
|
### Requirements
|
|
|
|
We use `uv` to manage and install dependencies. [uv](https://docs.astral.sh/uv/) is a fast Python package manager that can be installed with:
|
|
|
|
```
|
|
pip install uv
|
|
```
|
|
|
|
We'll also need `nox` for automated testing in multiple Python environments so [install that too](https://nox.thea.codes/en/stable/).
|
|
|
|
To install the local development requirements inside a virtual environment run:
|
|
|
|
```
|
|
$ uv sync --all-extras
|
|
$ uv run inv install-hooks
|
|
```
|
|
|
|
> For more information about `uv` check the [docs](https://docs.astral.sh/uv/).
|
|
|
|
We use [invoke](http://www.pyinvoke.org/) to wrap up some useful tasks like formatting, linting, testing and more.
|
|
|
|
Execute `inv[oke] --list` to see the list of available commands.
|
|
|
|
## Running _AI Marketplace Monitor_ from source code
|
|
|
|
If you would like to run the latest version of _AI Marketplace Monitor_ or test a branch, please checkout the repository
|
|
|
|
```sh
|
|
git clone https://github.com/BoPeng/ai-marketplace-monitor
|
|
cd ai-marketplace-monitor
|
|
```
|
|
|
|
or updating a local copy with commands
|
|
|
|
```sh
|
|
cd ai-marketplace-monitor
|
|
git pull
|
|
```
|
|
|
|
switch to a branch, e.g. `dev`, if needed,
|
|
|
|
```sh
|
|
git checkout dev
|
|
```
|
|
|
|
Then install the tool from source code with command
|
|
|
|
```sh
|
|
uv sync
|
|
```
|
|
|
|
## Contributing
|
|
|
|
### Issues
|
|
|
|
We use GitHub issues to track public bugs/enhancements. Report a new one by [opening a new issue](https://github.com/BoPeng/ai-marketplace-monitor/issues).
|
|
|
|
In this repository, we provide a couple of templates for you to fill in for:
|
|
|
|
- Bugs
|
|
- Feature Requests/Enhancements
|
|
|
|
Please read each section in the templates and provide as much information as you can. Please do not put any sensitive information,
|
|
such as personally identifiable information, connection strings or cloud credentials. The more information you can provide, the better we can help you.
|
|
|
|
### Pull Requests
|
|
|
|
Please follow these steps to have your contribution considered by the maintainers:
|
|
|
|
1. Fork the repo and create your branch locally with a succinct but descriptive name.
|
|
2. Add tests for the new changes
|
|
3. Edit documentation if you have changed something significant
|
|
4. Make sure to follow the [styleguides](#styleguides)
|
|
5. Open a PR in our repository and follow the PR template so that we can efficiently review the changes
|
|
6. After you submit your pull request, verify that all status checks are passing
|
|
|
|
While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional design
|
|
work, tests, or other changes before your pull request can be ultimately accepted.
|
|
|
|
## Styleguides
|
|
|
|
### Python Code Style
|
|
|
|
All Python code is linted with [Ruff](https://github.com/astral-sh/ruff) and formated with
|
|
[Isort](https://github.com/PyCQA/isort) and [Black](https://github.com/psf/black). You can
|
|
execute `inv[oke] lint` and `inv[oke] format`.
|
|
|
|
## Additional Notes
|
|
|
|
If you have any question feel free to contact us at email.
|