-
-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Guidelines were proudly stolen from the frontend repo and modified to better fit this one
- Loading branch information
Showing
1 changed file
with
16 additions
and
0 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
# Contributing | ||
Aka. Developer Guidelines | ||
|
||
## Intro | ||
|
||
We're currently _very_ early in the development stages of the Sublinks federation service. Therefore there aren't too many guidelines yet. However, as you can see below there are some that we would appreciate you to consider before and while you contribute to this project. | ||
|
||
As with most things you'll read about in this document, even these guidelines are up for discussion. If you believe anything should be changed please feel free to create a pull request and let us know what and why. Same thing applies if you want to add or stricten/loosen a guideline. | ||
|
||
## Tests | ||
|
||
Support for tests has been set up. Please submit unit and/or end-to-end tests with all PRs. 100% coverage (at least with unit tests) is a falacy. Ideally we want to strive for "good enough" coverage instead. | ||
|
||
## Pull Requests | ||
|
||
The pull request flow in this project isn't anything special. We require a pull request to be created before anything is merged into `main`. At least one person must approve the pull request. |