docs: add special github docs (#30)

jtrrll · Sep 3, 2024 · e8aa9a6 · e8aa9a6
1 parent cf28587
commit e8aa9a6
Show file tree

Hide file tree

Showing 5 changed files with 20 additions and 0 deletions.
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -0,0 +1 @@
+* @jtrrll
diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md
@@ -0,0 +1,3 @@
+# Code of Conduct
+
+Be ambitious, direct, and kind.
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -0,0 +1,14 @@
+# Contributing
+
+When contributing to this repository, please first open an issue to start a
+discussion about your contribution.
+
+We have a code of conduct, please follow it in all your interactions with the project.
+
+## Pull Request Process
+
+1. Ensure your changes work locally, are well documented, and well tested.
+2. Open a Pull Request with a descriptive, succinct title.
+Add any comments and tags you deem necessary.
+3. You may squash merge the Pull Request once the number of required
+approvals is met and all required status checks pass.
diff --git a/LICENSE → .github/LICENSE.md b/LICENSE → .github/LICENSE.md
@@ -1,3 +1,5 @@
+# License
+
 MIT License
 
 Copyright (c) 2024 Jackson Terrill

diff --git a/README.md → .github/README.md b/README.md → .github/README.md
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Code of Conduct

		Be ambitious, direct, and kind.