Horacio Duran
822e42dbb8
This template allows deploying a forgejo en either Scaleway or Hetzner (untested) without much knowledge about them. It DOES require knowledge about Terragrunt and ansible. A wizard of sorts is provided but it will not guarantee success without some knowledge about the underlying technology.
107 lines
3.2 KiB
Markdown
107 lines
3.2 KiB
Markdown
# Contributing
|
|
|
|
Thank you for your interest in contributing! This repository is hosted on a private Forgejo instance without public registration, but we welcome contributions from anyone.
|
|
|
|
**Authoritative repository:** https://git.dumontix.eu/dumontix/forgejo-autohebergement
|
|
**Codeberg mirror:** https://codeberg.org/dumontix/forgejo-autohebergement
|
|
|
|
Choose the method that matches your experience level:
|
|
|
|
---
|
|
|
|
## Simple Method (Recommended for Most Contributors)
|
|
|
|
If you're new to Git or prefer a straightforward process:
|
|
|
|
### Fork on Codeberg And Pull Request
|
|
|
|
1. Go to the [Codeberg mirror](https://codeberg.org/dumontix/forgejo-autohebergement)
|
|
2. Click **Fork** to create a copy in your Codeberg account
|
|
3. Clone your fork and make your changes
|
|
4. Push your changes to your fork
|
|
5. Make a Pull Request to the [Codeberg mirror](https://codeberg.org/dumontix/forgejo-autohebergement) after some reviewing ill make sure to merge it into the autoritative repo.
|
|
|
|
### Submit via Issue
|
|
|
|
1. Performs steps 1-4 of the previous section.
|
|
2. Open an issue at the [authoritative repository](https://git.dumontix.eu/dumontix/forgejo-autohebergement/issues)
|
|
3. Title it: **"Contribution: [brief description]"**
|
|
4. Include:
|
|
- A link to your Codeberg fork/branch
|
|
- A description of what you changed and why
|
|
|
|
We'll review your changes and merge them manually. You'll be credited as the author in the commit.
|
|
|
|
**Example issue:**
|
|
|
|
```
|
|
Title: Contribution: Fix typo in README
|
|
|
|
Link: https://codeberg.org/youruser/forgejo-autohebergement/src/branch/fix-typo
|
|
|
|
Description:
|
|
Fixed a typo in the installation instructions. "recieve" -> "receive"
|
|
```
|
|
|
|
---
|
|
|
|
## Expert Method: Email Patches
|
|
|
|
For experienced Git users who prefer the traditional kernel-style workflow:
|
|
|
|
### Generate Patches
|
|
|
|
```bash
|
|
# Clone the Codeberg mirror
|
|
git clone https://git.dumontix.eu/dumontix/forgejo-autohebergement.git
|
|
cd forgejo-autohebergement
|
|
git checkout -b my-feature
|
|
|
|
# Make commits with good messages
|
|
git commit -s -m "component: brief description
|
|
|
|
Longer explanation of what and why."
|
|
|
|
# Generate patch files
|
|
git format-patch origin/main --stdout > my-feature.patch
|
|
```
|
|
|
|
### Submit Patches
|
|
|
|
Open an issue at the [authoritative repository](https://git.dumontix.eu/dumontix/forgejo-autohebergement/issues) with the subject **"[PATCH] brief description"** and attach your patch file.
|
|
|
|
or
|
|
|
|
Send an email to `hduran` (at) `dumontix.fr` with the same subject as the Issue with the attached patch.
|
|
|
|
**Patch guidelines:**
|
|
- One logical change per patch
|
|
- Clear commit message explaining *what* and *why*
|
|
- Include `Signed-off-by` line (`git commit -s`)
|
|
- Test your changes before submitting
|
|
|
|
---
|
|
|
|
## Contribution Guidelines
|
|
|
|
Regardless of method:
|
|
|
|
- **Search existing issues** before submitting to avoid duplicates
|
|
- **Keep changes focused** - one feature/fix per contribution
|
|
- **Follow existing code style** - match the patterns you see
|
|
- **Test your changes** - make sure nothing breaks
|
|
|
|
---
|
|
|
|
## What Happens Next?
|
|
|
|
1. We'll review your contribution
|
|
2. We may ask questions or request changes via the issue
|
|
3. Once approved, we'll merge your changes with proper attribution
|
|
4. The issue will be closed with a link to the merged commit
|
|
|
|
---
|
|
|
|
## Questions?
|
|
|
|
Open an issue and we'll be happy to help.
|