Skip to content

Commit

Permalink
Add Contrib Guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
JesusMcCloud committed Aug 14, 2024
1 parent 11027a9 commit bf4d01f
Show file tree
Hide file tree
Showing 2 changed files with 57 additions and 0 deletions.
52 changes: 52 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
<div align="center">
<img src="https://github.com/user-attachments/assets/13750466-7d65-492f-9250-420da5467d2d">

# Contributing to A-SIT Plus Open Source

</div>

We are happy to receive external contributions!
"Just" opening issues for encountered problems is greatly appreciated too!

## Reporting Issues

We welcome constructive feedback and enquiries of any kind! Just be sure to check existing issues first to avoid duplicates.
Please try to be as precise as possible and provide a reproducer (where applicable).

## Contributing Changes

We expect the contributor to hold all rights to the contributions they are about to commit.
We particularly condemn copyright infringement and expect contributors to respect this position and strictly observe applicable law!

If you plan on contributing changes to this repository's contents, please

1. Fork it
2. Create a branch with a descriptive name (e.g. `feature/timeTravel` or `fix/gravitationalConstant`)
3. Commit your changes to your branch
4. Open a pull request

We will then review the changes, provide feedback.
Once we agree that the PR is ready, we will approve it, and your PR will be merged.

This project **does not** require external contributors to sign a Contributor License Agreement (CLA)!
Contributions are only subject to the terms of this project's license.

### Coding Conventions

We try to follow the [official Kotlin coding conventions](https://kotlinlang.org/docs/coding-conventions.html) and expect the same from external contributors.
We don't have any automated checks in place and hence don't strictly enforce convention rules by hard, but we will manually check for obvious violations.
To put it plain and simple:

> When in Rome, do as the Romans do!

<br>

<hr>
<div align="center">

Copyright &copy; 2024 A-SIT Plus GmbH, Seidlgasse 22 / Top 9, 1030 Vienna, Austria

<img src="https://a-sit-plus.github.io/logo_kurzertext.svg" width="163" height="64">

</div>
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -233,6 +233,11 @@ The key can be passed in either encoding to the secure enclave when creating an

<br>

## Contributing
External contributions are greatly appreciated!
Just be sure to observe the contribution guidelines (see [CONTRIBUTING.md](CONTRIBUTING.md)).


---
<p align="center">
This project has received funding from the European Union’s Horizon 2020 research and innovation
Expand Down

0 comments on commit bf4d01f

Please sign in to comment.