56 lines
1.3 KiB
Markdown
56 lines
1.3 KiB
Markdown
# Contributing
|
|
|
|
Want to contribute? Great! I'll be happy to review your contributions.
|
|
|
|
ATTENTION! PULL REQUESTS/MERGE REQUESTS or opening ISSUES on the repository platform itself are not accepted. Instead, everything is handled via email.
|
|
|
|
## Issue
|
|
|
|
Send an email to `hi [at] andros.dev` with the subject `Issue: Issue title` and the following structure:
|
|
|
|
```
|
|
Repository: repository-name
|
|
Description:
|
|
Detailed issue description goes here.
|
|
```
|
|
|
|
Feel free to attach screenshots, logs, or any other relevant information.
|
|
|
|
## Patch
|
|
|
|
Equivalent to a Pull/Merge Request.
|
|
|
|
### 1. Prepare
|
|
|
|
```sh
|
|
git clone https://example.com/repo.git
|
|
cd repo
|
|
git switch -c my-fix
|
|
```
|
|
|
|
### 2. Make changes
|
|
|
|
Make your modifications to the code. Test them to ensure everything works correctly.
|
|
|
|
### 3. Generate patch with git
|
|
|
|
If you do not know to do it, please read this [article](https://en.andros.dev/blog/75beece9/sending-patches-via-email-with-git/).
|
|
|
|
### 5. Send
|
|
|
|
Send an email to `hi [at] andros.dev` with the subject `Patch: Patch title` and attach the generated `.patch` files. In the email body use the following structure:
|
|
|
|
```
|
|
Repository: repository-name
|
|
Description:
|
|
Detailed patch description goes here.
|
|
```
|
|
|
|
## Best Practices
|
|
|
|
- One patch = one logical change
|
|
- Test before sending
|
|
- Write clear commit messages
|
|
- Be patient with maintainers
|
|
- Accept feedback gracefully
|