diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dc36806ac..e02c8b8ca 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,41 +1,15 @@ # Contributing -To ensure a smooth experience for contributions, please first open an issue about the change you wish to make or contact -an active developer in some other way before making a change. +We are a small dev team centered around [Denis Vogel](https://www.mathi.uni-heidelberg.de/~vogel/), the creator of MaMpf. He started the project on June 4, 2017 out of frustration with the existing tools and their shortcomings when it comes to teaching mathematics and uploading recorded lectures to the web. He has since been the main developer and maintainer of the project and added tons of functionality throughout the years. MaMpf is now used every day by the mathematics department at Heidelberg University to host their lectures. It is constantly being improved and extended. -## Braches -We have the following branches: -- *production* -- *main* -- *mampf-next* -- feature-branches (names vary) -- *experimental* +Denis Vogel was joined by many students along the way working on the project in the role of a payed HiWis (German abbreviation for "Hilsfwissenschaftler", research assistants) at Heidelberg University. They have contributed to the project in various ways, such as implementing new features, fixing bugs, testing the software and improving the documentation. -### *production* -contains the actual version deployed on [mampf](mampf.mathi.uni-heidelberg.de). +The idea of MaMpf is to provide free material online to the whole world. In that spirit, the source code for MaMpf is open-source and licensed under the very permissive MIT license, so your university can host their own instance of MaMpf if they want to. -### *main* -is usually equal to *production*. Hotfixes are tested here before being merged to *production*. +--- -### *mampf-next* -is the next intended version for mampf. This version is automatically deployed on -[mampf-dev](mampf-dev.mathi.uni-heidelberg.de). Features should be developed in feature branches and merged here. +**While we welcome contributions from everyone, please keep in mind that we are a very small team and currently cannot provide extensive mentoring or guidance to new external contributors.** If you are a HiWi at Heidelberg University, that's of course a different story, but unfortunately, right now we don't have too much time to onboard new developers form the outside. Knowledge transfer is often easier in persona than having to write down everything online. We have done such efforts in our [Wiki](https://github.com/MaMpf-HD/mampf/wiki) and continue to improve it as living document but don't expect it to be fully self-contained. +Also note that due to MaMpf being very specific to our needs at Heidelberg University, we might reject contributions that are not in line with our vision for the project or too general (or too specific to another university) to be useful for us. Therefore, **please open an issue before starting to work on a pull request to discuss your idea with us**. -### feature branches -Collaborators may create a branch for each improvement they would like to integrate in *mampf-next*. If you do not have -collaborator access yet, feel free to instead fork this repository and open a pull request targeted on the *mampf-next* -branch. - -### *experimental* -is used as a playground and for test deployments. Do **not** put important work here. This branch is intended to be -force-pushed by any collaborator. If you ever want to deploy a version in a production-like environment, feel free to -do - -> git checkout experimental -> -> git reset --hard -> -> git push -f - -If you are not a collaborator, feel free to open a pull-request on experimental with a note, that you are aware of this -policy and would just like to try out a change. +> [!tip] +> Check out our [**Wiki**](https://github.com/MaMpf-HD/mampf/wiki) if you are a new MaMpf developer and want to get started with setting up your own local Docker instance and get to know our development workflow and the code structure. diff --git a/LICENSE b/LICENSE index 8e20f5503..5e079cec0 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2017 Denis Vogel +Copyright (c) 2017-2024 Denis Vogel & Contributors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/config/locales/de.yml b/config/locales/de.yml index fa4875bc7..bfd5f46e5 100644 --- a/config/locales/de.yml +++ b/config/locales/de.yml @@ -78,7 +78,7 @@ de: Deiner Profilseite Zugriff erhalten. footer: text_html: > - © MaMpf Team 2023. MaMpf ist auf %{github}. + © MaMpf Team 2024. MaMpf ist auf %{github}. Powered by %{rails}, %{bootstrap}, %{cytoscape}, %{nerdamer}, %{katex}, %{thredded}, %{docker}, %{basecamp}. Bugs meldest Du am besten %{bugs}. diff --git a/config/locales/en.yml b/config/locales/en.yml index 454915f45..5db9ecbc9 100644 --- a/config/locales/en.yml +++ b/config/locales/en.yml @@ -101,7 +101,7 @@ en: You may get access by modifying your account settings. footer: text_html: > - © MaMpf Team 2023. MaMpf is on %{github}. + © MaMpf Team 2024. MaMpf is on %{github}. Powered by %{rails}, %{bootstrap}, %{cytoscape}, %{nerdamer}, %{katex}, %{thredded}, %{docker}, %{basecamp}. Bugs can be reported %{bugs}.