diff --git a/README.md b/README.md index e265655b38b6283807cdcfa97de7a0fb03e122a5..91a3205745794c96d30cfe17d4938597069f2c6a 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/buildimages/README.md b/buildimages/README.md new file mode 100644 index 0000000000000000000000000000000000000000..f158050bf2ae7e42dc1292a29086054d89384f3a --- /dev/null +++ b/buildimages/README.md @@ -0,0 +1,3 @@ +# Theodolite Build Images + +This directory contains some Dockerfiles for images required for Theodolite build infrastructure. diff --git a/docs/development/index.md b/docs/development/index.md index a427c98d6cff655e74bb7a42a92c9cb4e46b3404..8fed83551bb7dd24510bf102d7c40b1d4ad4aa3a 100644 --- a/docs/development/index.md +++ b/docs/development/index.md @@ -1,5 +1,29 @@ --- -title: Development +title: Contributing has_children: true nav_order: 10 ---- \ No newline at end of file +--- + +# 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. diff --git a/docs/development/release-process.md b/docs/development/release-process.md index c7ef78ad6b2a2485fb715afea2dd0a5021e1b7a0..576bee3861679d056d2290b33ae4b3b9ce90209d 100644 --- a/docs/development/release-process.md +++ b/docs/development/release-process.md @@ -1,7 +1,7 @@ --- title: Release Process has_children: false -parent: Development +parent: Contributing nav_order: 1 --- diff --git a/docs/project-info.md b/docs/project-info.md index 3fdb921965ef2771805d015a2b7c6723267ad068..bb02abcd1ae8cdb42deb85d17490fbaf9f02ea8b 100644 --- a/docs/project-info.md +++ b/docs/project-info.md @@ -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