30 lines
741 B
Markdown
30 lines
741 B
Markdown
# Contributing to Ren Browser
|
|
|
|
I welcome all contributions to the project.
|
|
|
|
## Places to help out
|
|
|
|
- Styling/Design (I am bad at this)
|
|
- Documentation
|
|
- Micron Renderer/Parser
|
|
- Android and Flet (config/permissions/etc)
|
|
|
|
## Rules
|
|
|
|
1. Be nice to each other.
|
|
|
|
## Generative AI Usage
|
|
|
|
You are allowed to use generative AI tools to help learn and contribute. You do not need to disclose you used a AI tool, although that would help me scrutinize the PR more for bugs, errors or security flaws.
|
|
|
|
## Linting, Security and Tests
|
|
|
|
You are not required to run the linting, security and tests before submitting the PR as those will be run by the CI/CD pipeline.
|
|
|
|
## Testing
|
|
|
|
To run the tests, use the following command:
|
|
|
|
```bash
|
|
poetry run pytest
|
|
``` |