Skip to content

Commit

Permalink
Add Contributing Guidelines
Browse files Browse the repository at this point in the history
Guidelines were proudly stolen from the frontend repo and modified to better fit this one
  • Loading branch information
lazyguru committed Dec 6, 2023
1 parent 9400de7 commit 5cb67bb
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions CONTRIBUTING.md
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.

0 comments on commit 5cb67bb

Please sign in to comment.