FancyInnovations/FancyPlugins
1
0
Fork 0
mirror of https://github.com/FancyInnovations/FancyPlugins.git synced 2025-12-06 07:43:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Rename guideline files for clarity and accessibility

Browse Source
This commit is contained in:
Oliver
2025-03-15 00:09:54 +01:00
parent 934219b659
commit 5c643d34e0
4 changed files with 0 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
docs/src/development-guidelines/contributing.md Normal file
View File

@@ -0,0 +1,48 @@
---
order: 10
---
# Contributing
This topic is all about the development guidelines that we follow. It is important to follow these
guidelines to maintain the quality of the code and to make sure that the code is consistent and easy to read.
## Pull Requests
Generally pull requests are welcome. However, it is important to follow the guidelines below when creating a pull
request.
If you plan to make a major change to the code, please join our discord server and discuss it with us before creating a
pull request out of nowhere.
### Code Style
Please try to adapt to the code style that is already present in the project. If you are unsure about the code style,
please join our discord server and ask for help.
If you have suggestions for a better code style, please join our discord server and discuss it with us.
### Commit Messages
Please make sure that your commit messages are clear and concise. It is important to write a good commit message so that
it is easy to understand what the commit is about.
Keep the commit message short and to the point. If you need to write a longer message, please use the body of the
commit.
Follow the format described in the [Monorepo](monorepo.md) guidelines.
### Testing
Please make sure that your code is tested before marking the pull request as ready for review. This means that the code
should compile and run without any errors. If you are unsure about how to test your code, please join our discord server
and ask for help.
When creating a PR for FancyNpcs please run the `/fancynpcs test` command in-game and attach a screenshot of the output
to the PR.
### Documentation
Please add documentation to your code. This means that you should add comments to your code so that it is easy
to understand what the code is doing. Also, please add Javadocs to the code if it is a public API.
If you modified, added or removed any commands, please update the `/npcs help` messages and the docs.