Skip to content
Snippets Groups Projects
Commit 409d2f14 authored by Sören Henning's avatar Sören Henning
Browse files

Add contributing guide

parent 84d589ef
No related branches found
No related tags found
No related merge requests found
Pipeline #10369 failed
......@@ -23,6 +23,13 @@ Documentation on Theodolite itself as well as regarding its benchmarking method
* The source code of Theodolite's SLO checkers are located in [`slo-checker`](slo-checker).
* The documentation, which is hosted on [theodolite.rocks](https://www.theodolite.rocks), is located in [`docs`](docs).
## Contributing
We are happy to accept any kind of contributions to Theodolite.
This includes reporting any issues you find using Theodolite, bug fixes and improvements as well as integrating your research within the project.
See our website to [start contributing](https://www.theodolite.rocks/development/).
## How to Cite
If you use Theodolite, please cite
......
# Theodolite Build Images
This directory contains some Dockerfiles for images required for Theodolite build infrastructure.
---
title: Development
title: Contributing
has_children: true
nav_order: 10
---
# Contributing
Theodolite is open-source research software. We welcome everyone to contribute to this project.
Contributions are not limited to code contributions, instead we welcome and recognize everything concerning:
* Raising issues, questions and suggestions for using Theodolite
* Fixing bugs or implementing new features
* Improving the documentation
* Using Theodolite as part of your (not necessarily scientific) research
* Reporting on your scalability evaluations with Theodolite
## Start Contributing
If you have bug reports, feature requests, questions or suggestions, you may create a [GitHub issue](https://github.com/cau-se/theodolite/issues) or directly [contact Theodolite's maintainers](project-info).
You can also create a [GitHub pull request](https://github.com/cau-se/theodolite/pulls) if you have already implemented bug fixes and improvements.
If you would like to get more involved in Theodolite's project development and maintenance, you may contact us as well so we can set you up an account for [our internal GitLab](project-info#project-management).
## Internal Project Structure
Theodolite is organized as a monorepo containing multiple largely independent modules in subdirectories.
See the project's [`README.md`](https://github.com/cau-se/theodolite/blob/main/README.md#project-structure) for an overview of all modules.
Each module directory provides a dedicated `README.md` file describing how to build, test, package,... the corresponding module.
---
title: Release Process
has_children: false
parent: Development
parent: Contributing
nav_order: 1
---
......
......@@ -15,7 +15,20 @@ You might also want to raise an issue on [GitHub](http://github.com/cau-se/theod
## Project Management
Theodolite's internal development including issue boards, merge requests and extensive CI pipelines is tracked in our [internal GitLab](https://git.se.informatik.uni-kiel.de/she/theodolite). We provide a public mirror on GitHub, [cau-se/theodolite](http://github.com/cau-se/theodolite), where we are also happy to welcome issues and pull requests.
Theodolite's internal development including issue boards, merge requests and extensive CI pipelines is tracked in our [internal GitLab](https://git.se.informatik.uni-kiel.de/she/theodolite).
While all internal development is publicly accessible, contributing requires an account to be set up.
To ease contribution, we provide a public mirror on GitHub, [cau-se/theodolite](http://github.com/cau-se/theodolite), where we are also happy to welcome issues and pull requests.
Also releases are published via GitHub. See the following table for an overview:
| Project management | Public GitHub | Internal GitLab |
|:---|:---|:---|
| Source code | [GitHub](https://github.com/cau-se/theodolite) | [GitLab](https://git.se.informatik.uni-kiel.de/she/theodolite) |
| Issue Tracking | [GitHub Issues](https://github.com/cau-se/theodolite/issues) | [GitLab Issues](https://git.se.informatik.uni-kiel.de/she/theodolite/-/issues) |
| Pull/Merge requests | [GitHub Pull requests](https://github.com/cau-se/theodolite/pulls) | [GitLab Merge requests](https://git.se.informatik.uni-kiel.de/she/theodolite/-/merge_requests) |
| Roadmap | | [GitLab Milestones](https://git.se.informatik.uni-kiel.de/she/theodolite/-/milestones) |
| CI/CD pipelines | | [GitLab CI/CD](https://git.se.informatik.uni-kiel.de/she/theodolite/-/pipelines) |
| Releases | [GitHub Releases](https://github.com/cau-se/theodolite/releases) | [GitLab Releases](https://git.se.informatik.uni-kiel.de/she/theodolite/-/releases) |
| Container images | [GitHub Packages](https://github.com/orgs/cau-se/packages?repo_name=theodolite) | |
## Contributors
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment