-
-
Notifications
You must be signed in to change notification settings - Fork 378
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Extend core ideas documentation (#3405)
Co-authored-by: Robert Kaussow <xoxys@rknet.org>
- Loading branch information
Showing
2 changed files
with
26 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
# Core ideas | ||
|
||
- A configuration (e.g. of a pipeline) should never be [turing complete](https://en.wikipedia.org/wiki/Turing_completeness) (We have agents to exec things 🙂). | ||
- If possible, follow the [KISS principle](https://en.wikipedia.org/wiki/KISS_principle). | ||
- What is used most often should be default. | ||
- Keep different topics separated, so you can write plugins, port new ideas ... more easily, see [Architecture](./05-architecture.md). | ||
|
||
## Addons and extensions | ||
|
||
If you are wondering whether your contribution will be accepted to be merged in the Woodpecker core, or whether it's better to write an | ||
[addon](../30-administration/75-addons/00-overview.md), [extension](../30-administration/100-external-configuration-api.md) or an | ||
[external custom backend](../30-administration/22-backends/50-custom-backends.md), please check these points: | ||
|
||
- Is your change very specific to your setup and unlikely to be used by anyone else? | ||
- Does your change violate the [guidelines](#guidelines)? | ||
|
||
Both should be false when you open a pull request to get your change into the core repository. | ||
|
||
### Guidelines | ||
|
||
#### Forges | ||
|
||
A new forge must support these features: | ||
|
||
- OAuth2 | ||
- Webhooks |