Added a CONTRIBUTING.md that describes how people can contribute to this project. I added parts inspired by other projects. I tried to keep it short and simple, as there is currently not a lot of contribution.
Descript how people can contribute to this project #116
duco/lerntools_base:duco-patch-1 into main Added a CONTRIBUTING.md that describes how people can contribute to this project. I added parts inspired by other projects. I tried to keep it short and simple, as there is currently not a lot of contribution.
The wiki contains helpful information for the development, so it is helpful to mention it here, so contributors can find it more easily.
Dies ist ein erster Entwurf, der durch eine Diskusion auf Mastodon angeregt wurde. Ich bin offen für Verbesserungsvorschläge. Eine der großen offenen Fragen ist hier wohl auch die Thematik mit Deutsch und Englisch. Normalerweise werden projekte komplett in Englisch entwickelt. In diesem Projekt ist aber vieles auf Deutsch. Soll es da irgendwelche Regelungen geben?
Danke für die Arbeit. Unsere Coder müssen noch draufschauen 😀
Von der Sprache her werden wir wohl erstmal zweisprachig bleiben: Wir sind bisher ein rein deutsches Team mit fast nur deutschen Besuchern.
Sinnvoll wäre: Code und Commits auf Englisch, Issues diskutieren wir auch gerne auf Deutsch
Sinnvoll wäre: Code und Commits auf Englisch, Issues diskutieren wir auch gerne auf Deutsch
Dem schließe ich mich an.
@ -0,0 +12,4 @@
* Stay respectful while contributing.
* Personal attacks are not allowed.
* Discrimination based on race/ethnic group, gender, age, religion, disability or sexuality is not allowed.
Ist das eine abschließende Liste?
Es ist eine Liste, von Dingen, die hier hoffentlich nicht toleriert werden. Ich weiß nicht, was "abschließend" in diesem Kontext bedeuten soll. Ich sehe das wie Gesetze in einem Staat. Da gibt es Gesetze und mit der Zeit können die sich ändern und neue hinzu kommen. Zu einem Zeitpunkt gilt ein bestimmtes Set an Gesetzen. Mit diesem PR schlage ich dieses Set an Regeln vor. Sollte es Probleme mit irgendwas geben, kann man natürlich neue einführen oder meinen Vorschlag überarbeiten.
Da stimme ich @duco zu: Es ist ein Anfang.
@ -0,0 +16,4 @@
## Issues (Bugs and feature requests)
Please use the search function on the [issues page](https://codeberg.org/lerntools/base/issues) first, to check if the issue was already created by someone else. You can [write new Bug reports and feature requests](https://codeberg.org/lerntools/base/issues/new) in English or German. If you just have a question feel free to ask at [Mastodon](https://bildung.social/@lerntools).
*bug reports
(klein geschrieben)
@ -0,0 +39,4 @@
* Use the present tense ("Add feature" not "Added feature")
* Limit the first line to 72 characters or less
* Reference related issues and pull requests
* Describe the changes, so users and administrators will understand it (not "fix bug in App.vue", better "Stop navigation bar from flickers")
Wir sollten noch erwähnen, dass die Änderungen im Allgemeinen gegen dev erfolgen sollten.
Guter Punkt. Habe ich ergänzt.
@ -0,0 +46,4 @@
* Half finished changes will not be merged. If you plan to further work on it wait until you are finished with the pull request or add "WIP:" in front of the title.
* The build command has to work without errors.
* Don't put code into comments. If code isn't needed anymore, delete it. If we like to look up the previous code we always can use the git history. There is no need keep it in comments.
* If you change the dependencies in the `package.json`, always run `yarn install` to add them to the `yarn.lock` file as well.
*yarn
(install sollte nicht notwendig sein, glaube ich)
Das würde reichen, ja. Die Dokumentation von yarn sagt dazu:
Running
yarnwith no command will runyarn install, passing through any provided flags.
Ich würde jedoch empfehlen yarn install in der dokumentation zu schreiben, denn
- es it explizit (dort steht also was passiert, man muss nicht wissen, dass dadurch etwas installiert wird)
- man kann danach suchen (wenn man einfach nach
yarnsucht ist es viel schwieriger heraus zu finden, was der Befehl macht. Wenn man nachyarn installsucht kommt man direkt zur Doku) - andere Projekte geben das auch so an, wie Mastodon
Sinnvoll wäre: Code und Commits auf Englisch, Issues diskutieren wir auch gerne auf Deutsch
Dem schließe ich mich an.
@duco kannst du die Sprachenfrage noch mit aufnehmen?
No due date set.
No dependencies set.
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?