sweep: add contributor guidelines

[superbarne]

add contributor guidelines for this repository

Checklist

• Create CONTRIBUTING.md ✓ 8e5b6c4 Edit
• Running GitHub Actions for CONTRIBUTING.md ✓ Edit

[superbarne]

🚀 Here's the PR! #73

See Sweep's progress at the progress dashboard!

💎 Sweep Pro: I'm using GPT-4. You have unlimited GPT-4 tickets. (tracking ID: None)

Install Sweep Configs: Pull Request

---

Tip

I can email you next time I complete a pull request if you set up your email here!

---

Actions (click)

• ↻ Restart Sweep

GitHub Actions failed

The sandbox appears to be unavailable or down.

---

Step 1: 🔎 Searching

I found the following snippets in your repository. I will now analyze these snippets and come up with a plan.

Some code snippets I think are relevant in decreasing order of relevance (click to expand). If some file is missing from here, you can mention the path in the ticket description.

brahmsee.digital/frontend/src/views/Development/Mitwirkende.vue

Lines 1 to 222 in b6c6e82

	<script setup lang="ts">
	import { CheckCircleIcon } from '@heroicons/vue/24/outline'
	const people = [
	{
	name: 'Daniel Swiatek',
	role: 'Initator',
	imageUrl: 'https://avatars.githubusercontent.com/u/9080990?v=4',
	},
	{
	name: 'Torge Jürgensen',
	role: 'Contributor',
	imageUrl: 'https://avatars.githubusercontent.com/u/7646204?v=4',
	},
	{
	name: 'Axel Rindle',
	role: 'Contributor',
	imageUrl: 'https://avatars.githubusercontent.com/u/7105632?v=4',
	},
	{
	name: 'Momme Jürgensen',
	role: 'Contributor',
	imageUrl: 'https://avatars.githubusercontent.com/u/15056397?v=4',
	},
	{
	name: 'Lasse Eggers',
	role: 'Contributor',
	imageUrl: 'https://avatars.githubusercontent.com/u/29912749?v=4',
	},
	{
	name: 'Lukas Hauenstein',
	role: 'Contributor',
	imageUrl: 'https://avatars.githubusercontent.com/u/20169396?v=4',
	},
	{
	name: 'Barne Jürgensen',
	role: 'Contributor',
	imageUrl: 'https://avatars.githubusercontent.com/u/1502820?v=4',
	},
	{
	name: 'Jeremy Boy',
	role: 'Contributor & Sponsor',
	imageUrl: 'https://avatars.githubusercontent.com/u/6078522?v=4',
	},
	{
	name: 'Fabian Rogge',
	role: 'Contributor',
	imageUrl: 'https://avatars.githubusercontent.com/u/16214836?v=4',
	},
	{
	name: 'CODEANKER',
	role: 'Sponsor',
	imageUrl: 'https://avatars.githubusercontent.com/u/13403000?v=4',
	},
	{
	name: 'ACT',
	role: 'Sponsor',
	imageUrl: 'https://avatars.githubusercontent.com/u/150189827?v=4',
	},
	]
	</script>
	<template>
	<div class="bg-white py-10 px-8 md:px-8 lg:px-0">
	<div class="mx-auto max-w-3xl text-base leading-7 text-gray-700">
	<h1 class="mt-2 text-3xl font-bold tracking-tight text-gray-900 sm:text-4xl">Ein Open-Source Projekt</h1>
	<p class="mt-6 text-xl leading-8">
	Diese Software wird als Open-Source Projekt entwickelt. Jede Person kann sich einbringen und an diesem Projekt
	mitarbeiten. Der Code ist öffentlich zugänglich und kann frei verwendet werden.
	</p>
	<div class="mt-10 max-w-2xl">
	<p>
	Es gab schon immer die Idee eine Software zur Anmeldung für das Landeskindertreffen zu entwickeln. Mehrere
	Anläufe sind aus verschiedensten Gründen gescheitert. Im Jahr 2023 gab es einen neuen Anlauf. Viele der
	Contributoren sind beruflich in de Softwareentwicklung tätig und haben sich bereit erklärt, dieses Projekt zu
	unterstützen. Mit einem gemeinsamen Kickoff im Gästehaus der DLRG in Eckernförde haben wir gestartet und
	entwickeltn seit dem gemeinsam an diesem Projekt. Dort haben wir uns auch entschieden das Projekt als
	Open-Source zu entwickeln.
	</p>
	<figure class="mt-10 border-l border-primary-600 pl-9">
	<blockquote class="font-semibold text-gray-900">
	<p>
	“Für das Landeskindertreffen wollte ich eine Software zur Anmeldung entwickeln und habe engagierte
	Menschen aus meinem beruflichen und privaten Umfeld gefunden.”
	</p>
	</blockquote>
	<figcaption class="mt-6 flex gap-x-4">
	<img
	class="h-6 w-6 flex-none rounded-full bg-gray-50"
	src="https://avatars.githubusercontent.com/u/9080990?v=4"
	alt=""
	/>
	<div class="text-sm leading-6">
	<strong class="font-semibold text-gray-900">Daniel Swiatek</strong> – Initator
	</div>
	</figcaption>
	</figure>
	<p class="mt-8">
	"Wir laden dich herzlich dazu ein, an unserem Open Source Software-Projekt für die Veranstaltungsanmeldung
	teilzunehmen! Gemeinsam gestalten wir eine offene und kollaborative Umgebung, in der jede Stimme zählt. Deine
	Fähigkeiten und Ideen sind von unschätzbarem Wert, um diese Plattform zu verbessern und zu erweitern.
	</p>
	<p>
	Durch die Mitarbeit an diesem Projekt trägst du nicht nur zur Entwicklung einer benutzerfreundlichen und
	effizienten Lösung für die Veranstaltungsorganisation bei, sondern erfährst auch den unmittelbaren Einfluss
	deiner Beiträge. Es ist eine Gelegenheit, mit Gleichgesinnten zusammenzuarbeiten, Wissen zu teilen und
	gemeinsam innovative Lösungen zu schaffen.
	</p>
	<p>
	Egal, ob du Entwickler:in, Designer:in, Tester:in oder einfach nur begeistert von Open Source bist – jede:r
	ist willkommen! Deine Beteiligung macht einen Unterschied. Deine Expertise ist gefragt, und wir freuen uns
	darauf, mit dir gemeinsam an diesem spannenden Projekt zu arbeiten!"
	</p>
	<h2 class="mt-16 text-2xl font-bold tracking-tight text-gray-900">Was ist Open Source?</h2>
	<p class="mt-6">
	Open Source Software (OSS) bezeichnet Software, deren Quellcode öffentlich zugänglich ist und die unter einer
	Lizenz veröffentlicht wird, die es erlaubt, den Code, zu verwenden, zu ändern und zu verteilen. Im Gegensatz
	zu proprietärer Software, bei der der Quellcode in der Regel nicht öffentlich einsehbar ist und nur die
	ausführbare Version der Software bereitgestellt wird, ermöglicht Open Source Software eine transparente
	Zusammenarbeit und partizipative Entwicklung. Das zeichnet Open Source aus:
	</p>
	<ul
	role="list"
	class="mt-8 max-w-xl space-y-8 text-gray-600"
	>
	<li class="flex gap-x-3">
	<CheckCircleIcon
	class="mt-1 h-5 w-5 flex-none text-primary-600"
	aria-hidden="true"
	/>
	<span
	><strong class="font-semibold text-gray-900">Freie Zugänglichkeit zum Quellcode:</strong> Das zentrale
	Merkmal von Open Source Software ist die offene Verfügbarkeit des Quellcodes. Jede:r kann den Quellcode
	einsehen, modifizieren und anpassen. Dies fördert Transparenz, ermöglicht Fehlerbehebungen und erlaubt es
	Entwickler:innen weltweit, zur Verbesserung der Software beizutragen.</span
	>
	</li>
	<li class="flex gap-x-3">
	<CheckCircleIcon
	class="mt-1 h-5 w-5 flex-none text-primary-600"
	aria-hidden="true"
	/>
	<span
	><strong class="font-semibold text-gray-900">Freie Verbreitung:</strong> Open Source Software kann frei
	kopiert, weitergegeben und verteilt werden. Benutzer:innen haben die Freiheit, die Software zu nutzen, zu
	teilen und sogar kommerziell zu vertreiben. Diese Freiheit zur Verbreitung fördert eine breite
	Verfügbarkeit und unterstützt die Verbreitung der Software in verschiedenen Umgebungen.</span
	>
	</li>
	</ul>
	<p class="mt-10">
	Durch diese Prinzipien fördert Open Source Software eine offene und kollaborative Entwicklungsweise, bei der
	die Stärken einer globalen Entwicklergemeinschaft genutzt werden, um qualitativ hochwertige Software zu
	schaffen.
	</p>
	</div>
	<div
	class="mx-auto flex flex-col gap-16 bg-white/5 px-6 py-16 ring-1 ring-white/10 lg:flex-row lg:items-center xl:gap-x-20 xl:px-20 border-t border-b mt-16"
	>
	<img
	class="h-32 w-32 flex-none rounded-full aspect-square"
	src="@/assets/images/svg/github-mark.svg"
	alt=""
	/>
	<div class="w-full flex-auto">
	<h2 class="text-3xl font-bold tracking-tight sm:text-4xl">Werde teil des Teams</h2>
	<p class="mt-6 text-lg leading-8">
	Starte jetzt die Mitarbeit am Projekt. Wir organisieren uns mit Issues und Pull-Requests und helfen dir beim
	On-Boarding.
	</p>
	<div class="mt-10 flex">
	<a
	href="https://github.com/codeanker/brahmsee.digital"
	target="_blank"
	rel="noopener noreferrer"
	class="text-sm font-semibold leading-6 text-primary-600"
	>zum Github-Projekt <span aria-hidden="true">&rarr;</span></a
	>
	</div>
	</div>
	</div>
	<div
	class="absolute inset-x-0 -top-16 -z-10 flex transform-gpu justify-center overflow-hidden blur-3xl"
	aria-hidden="true"
	>
	<div
	class="aspect-[1318/752] w-[82.375rem] flex-none bg-gradient-to-r from-[#80caff] to-[#4f46e5] opacity-25"
	style="
	clip-path: polygon(
	73.6% 51.7%,
	91.7% 11.8%,
	100% 46.4%,
	97.4% 82.2%,
	92.5% 84.9%,
	75.7% 64%,
	55.3% 47.5%,
	46.5% 49.4%,
	45% 62.9%,
	50.3% 87.2%,
	21.3% 64.1%,
	0.1% 100%,
	5.4% 51.1%,
	21.4% 63.9%,
	58.9% 0.2%,
	73.6% 51.7%
	);
	"
	/>
	</div>
	<div class="mt-16 max-w-2xl">
	<h2 class="text-2xl font-bold tracking-tight text-gray-900">
	Veilen Dank an alle Contributor:innen und Sponsoren
	</h2>
	<p class="mt-6">
	Ein großes Dankeschön geht an alle Contributor:innen und Sponsoren die an diesem Projekt mitgearbeitet haben.
	</p>
	</div>

---

Step 2: ⌨️ Coding

• Create CONTRIBUTING.md ✓ 8e5b6c4 Edit

Create CONTRIBUTING.md with contents:
• Start by creating a new file named `CONTRIBUTING.md` at the root of the repository. This file will contain the contribution guidelines for the project.
• Begin the document with a welcoming message to potential contributors, emphasizing the importance of community contributions to the project.
• Include a section titled "Setting Up Your Development Environment" that provides step-by-step instructions on how to set up the development environment for the project. This should cover cloning the repository, installing dependencies, and any other necessary setup steps.
• Add a section titled "Submitting Changes" that explains the process for submitting contributions to the project. This should include instructions on creating a fork of the repository, making changes in a feature branch, and submitting a pull request. Also, mention any requirements for pull request descriptions or linking issues.
• Include a section titled "Coding Standards and Conventions" that outlines any specific coding standards or style guidelines contributors should follow. This could cover naming conventions, code formatting, and best practices specific to Vue.js and TypeScript development.
• Add a section titled "Reporting Issues" that provides guidelines on how to report bugs or suggest enhancements. Include instructions on using issue templates if applicable.
• Conclude the document with a "Community and Support" section that provides information on how contributors can get help or discuss contributions with the project maintainers. Include links to any relevant community forums, chat rooms, or mailing lists.
• Ensure the document is clear, concise, and formatted for easy reading. Use markdown formatting to organize the content into sections, lists, and code blocks as appropriate.

• Running GitHub Actions for CONTRIBUTING.md ✓ Edit

Check CONTRIBUTING.md with contents:

Ran GitHub Actions for 8e5b6c4f8a176b9b17ce9185e4e81a05c6214ba2:

---

Step 3: 🔁 Code Review

I have finished reviewing the code for completeness. I did not find errors for sweep/add_contributor_guidelines.

---

🎉 Latest improvements to Sweep:

• New dashboard launched for real-time tracking of Sweep issues, covering all stages from search to coding.
• Integration of OpenAI's latest Assistant API for more efficient and reliable code planning and editing, improving speed by 3x.
• Use the GitHub issues extension for creating Sweep issues directly from your editor.

💡 To recreate the pull request edit the issue title or description. To tweak the pull request, leave a comment on the pull request.^{Something wrong? Let us know.}