docs: add contributing guide

mosure · Nov 10, 2023 · b4893cf · b4893cf
1 parent 9998aba
commit b4893cf
Show file tree

Hide file tree

Showing 3 changed files with 36 additions and 3 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,33 @@
+# contributing to bevy_gaussian_splatting
+
+![alt text](docs/notferris2.webp)
+
+thank you for your interest in contributing to `bevy_gaussian_splatting`! contributions of all forms are welcome and appreciated. this includes code contributions, bug reports, documentation, or any other form of support.
+
+## getting started
+
+as `bevy_gaussian_splatting` is a smaller project, the contribution process is more informal. feel free to contribute in a way that aligns with your interests and expertise. if you have any questions or need guidance, don't hesitate to reach out.
+
+## ways to contribute
+
+1. **code contributions**: if you have improvements or new features in mind, feel free to open a pull request. for larger changes, it's a good idea to discuss them first through a github issue.
+
+2. **bug reports**: if you find any bugs, please open an issue describing the problem, including any relevant details that could help in resolving it.
+
+3. **documentation**: improvements or additions to documentation are always welcome. this can include both inline code comments and updates to readme or other markdown files.
+
+4. **ideas and suggestions**: have ideas for new features or ways to improve the project? open an issue to discuss your suggestions!
+
+## pull request process
+
+1. ensure that any new code complies with the existing code style and structure.
+2. update the readme.md or other documentation with details of changes, if applicable.
+3. open a pull request with a clear description of the changes.
+
+## questions?
+
+if you're unsure about something or need help, feel free to open an issue asking for guidance. as the project grows, we aim to make contributing as accessible and straightforward as possible.
+
+## code of conduct
+
+while we don't have a formal code of conduct, we expect contributors to be respectful, open-minded, and collaborative. let's work together to maintain a welcoming and inclusive environment.
diff --git a/README.md b/README.md
@@ -73,9 +73,9 @@ to build wasm run:
 ## compatible bevy versions
 
 | `bevy_gaussian_splatting` | `bevy` |
-| :--           | :--    |
-| `0.4`         | `0.12` |
-| `0.1 - 0.3`         | `0.11` |
+| :--                       | :--    |
+| `0.4`                     | `0.12` |
+| `0.1 - 0.3`               | `0.11` |
 
 
 # credits

diff --git a/docs/notferris2.webp b/docs/notferris2.webp