TheClashFruit/CreatePissAndShit
1
0
Fork 0
mirror of https://github.com/TheClashFruit/CreatePissAndShit.git synced 2024-09-19 01:16:45 +00:00
Code Activity

docs: readme changes and add CONTRIBUTING.md

Browse source
This commit is contained in:
TheClashFruit 2024-07-28 11:28:35 +02:00
parent aaf9e3d400
commit f8adf3ec8a
Signed by: TheClashFruit
GPG key ID: 09BB24C34C2F3204
2 changed files with 76 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

38
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,38 @@
# Contributing
Thank you for being interested in contributing to the project.
If you find any issues with this document feel free to open up a pull request to fix the issues.
If you have some suggestion on changing parts of the document feel free to open up an issue so the community can discuss your changes.
**_I have a question!_** Check the [FAQs](#faqs) section to see if your question was already answered, if it wasn't join my [Discord](https://discord.gg/CWEApqJ6rc) server or open up an issue.
## Stuff To Know Before Contributing
### Proposing a Feature
If you want to submit a new feature please don't open a pull request directly, open up an issue first for discussion, you can build your feature as the discussion and after the issue came to a conclusion and your feature was "approved" you can open up your pull request.
### Commit Messages
Please try to follow the repo's commit style if you plan on contributing. This helps to make the repo a bit more organised.
* Explain what the commit does or what did you do in the commit message with less than 50 characters.
* Use the commit description if you can't fit what you did in the commit message.
* Use one of these prefixes in your commit messages:
* `fix:` When you fixed a bug or maybe a flaw within the codebase.
* `feat:` When you added something within the codebase (can be anything).
* `tweak:` When you do a little tweak in the codebase, like a tiny texture change.
* `chore:` When you do fixed something, but it doesn't affect the mod in terms of functionality.
* `refactor:` When you refactored the code, like cleaning up the code.
* `docs:` When you changed the documentation, like the README.md file.
### Adding Yourself to the Credits
Please only add yourself to the credits in `fabric.mod.json` when your contribution is more significant to the project like fixing a bug or adding a feature.
## FAQs
There is nothing here yet!
<!-- Thanks, @iyxan23, for writing an awesome contributing guide in Blokkok that I stole and modified. :3 -->

41
README.md
View file

@ -1,6 +1,6 @@
<p align="center">
<h1 align="center">
<img alt="Create: Piss & Shit" width="70%" src="https://cdn.theclashfruit.me/data/modrinth/create-piss-n-shit/title.png">
</p>
</h1>
<div align="center">
<a href="https://modrinth.com/mod/create-piss-n-shit">
@ -14,6 +14,41 @@
</a>
</div>
<p align="center">
<img alt="GitHub Issues or Pull Requests" src="https://img.shields.io/github/issues/TheClashFruit/CreatePissAndShit">
<img alt="GitHub Issues or Pull Requests" src="https://img.shields.io/github/issues-pr/TheClashFruit/CreatePissAndShit">
<a title="Crowdin" target="_blank" href="https://crowdin.com/project/create-piss-n-shit">
<img src="https://badges.crowdin.net/create-piss-n-shit/localized.svg">
</a>
<img alt="GitHub License" src="https://img.shields.io/github/license/TheClashFruit/CreatePissAndShit">
</p>
<p align="center">
A Create add-on that adds piss and shit to the game with interesting mechanics!
</p>
</p>
## Getting Started
These steps will show you how you can build Create: Piss & Shit on your own.
### Cloning
This repository doesn't use any special stuff, so we can clone it in to old-fashioned way of `git clone https://github.com/TheClashFruit/CreatePissAndShit.git`.
### Building
Building is also straight forward, open the project in your desired code editor, IDE or just a terminal then just run `./gradlew build` in a terminal.
## Contributing
You can read the [CONTRIBUTING.md](CONTRIBUTING.md) file for details on the project's code of conduct, and the process for submitting pull requests to this project, have fun!
### Translations
If you want to help with translations just head over to the project's crowdin to get started: [crowdin.com/project/create-piss-n-shit](https://crowdin.com/project/create-piss-n-shit).
## License
This project is licensed under MIT, yes even the textures, if you want to learn more check the [LICENSE](LICENSE) file.