mirror of
https://github.com/AlexMacocian/MonoGame.Extended.git
synced 2026-07-15 15:09:29 +00:00
Christopher Whitley
9a7ce46635
* Removed Roadmap The Roadmap seems to have been initially added to show the plans to switch to an FNA fork and act as a bridge for katabasis. This is no longer the case for this repository as it will remain focused at the moment on MonoGame support only. * Added new note at top of readme * updated information for installing nuget * Made using content pipeline extensions a section and not a quote * Removed information about MyGet feed * Removed patreon from readme * Update License * renamed master branch to main * Remove community forum link MonoGame is closing the community forums in favor of discord and github discussions * Update workflows
71 lines
4.4 KiB
Markdown
71 lines
4.4 KiB
Markdown
# Contributing to MonoGame.Extended
|
|
|
|
We're happy that you have chosen to contribute to the MonoGame Extended project.
|
|
|
|
You are joining a team of dedicated volunteers that are building an extension library to the game framework [MonoGame](http://www.monogame.net/).
|
|
|
|
Please read this document completely before contributing.
|
|
|
|
|
|
## How To Contribute
|
|
|
|
MonoGame.Extended has a `main` branch for stable releases and a `develop` branch for daily development. New features and fixes are always submitted to the `develop` branch.
|
|
|
|
If you are looking for ways to help you should start by looking at the [Open Issues](https://github.com/craftworkgames/MonoGame.Extended/issues). Please let us know if you plan to work on an issue so that others are not duplicating work.
|
|
|
|
The MonoGame.Extended project follows standard [GitHub flow](https://guides.github.com/introduction/flow/index.html). You should learn and be familiar with how to [use Git](https://help.github.com/articles/set-up-git/), how to [create a fork of MonoGame.Extended](https://help.github.com/articles/fork-a-repo/), and how to [submit a Pull Request](https://help.github.com/articles/using-pull-requests/).
|
|
|
|
After you submit a PR the GitHub actions will trigger and build your changes and verify that all tests pass. Project maintainers and contributors will review your changes and provide constructive feedback to improve your submission.
|
|
|
|
Once satisfied that your changes are good for MonoGame.Extended we will merge it.
|
|
|
|
## Quick Guidelines
|
|
|
|
Here are a few simple rules and suggestions to remember when contributing to MonoGame.Extended.
|
|
|
|
* :bangbang: **NEVER** commit code that you didn't personally write.
|
|
* :bangbang: **NEVER** use decompiler tools to steal code and submit them as your own work.
|
|
* :bangbang: **NEVER** decompile XNA assemblies and steal Microsoft's copyrighted code.
|
|
* **PLEASE** try keep your PRs focused on a single topic and of a reasonable size or we may ask you to break it up.
|
|
* **PLEASE** be sure to write simple and descriptive commit messages.
|
|
* **DO NOT** surprise us with new APIs or big new features. Open an issue to discuss your ideas first.
|
|
* **DO NOT** reorder type members as it makes it difficult to compare code changes in a PR.
|
|
* **DO** give priority to the existing style of the file you're changing.
|
|
* **DO** try to add to our [unit tests](Source/MonoGame.Extended.Tests) when adding new features or fixing bugs.
|
|
* **DO NOT** send PRs for code style changes or make code changes just for the sake of style.
|
|
* **PLEASE** keep a civil and respectful tone when discussing and reviewing contributions.
|
|
* **PLEASE** tell others about MonoGame.Extended and your contributions via social media.
|
|
|
|
## Decompiler Tools
|
|
|
|
We prohibit tools like dotPeek, ILSpy, JustDecompiler, or .NET Reflector which convert compiled assemblies into readable code.
|
|
|
|
It is **NEVER ACCEPTABLE** to decompile copyrighted assemblies and submit that code to the MonoGame.Extended project.
|
|
|
|
* It **DOES NOT** matter how much you change the code.
|
|
* It **DOES NOT** matter what country you live in or what your local laws say.
|
|
* It **DOES NOT** matter that XNA is discontinued.
|
|
* It **DOES NOT** matter how small the bit of code you have stolen is.
|
|
* It **DOES NOT** matter what your opinion is of stealing code.
|
|
|
|
If you did not write the code, you do not have ownership of the code, and you shouldn't submit it to MonoGame.Extended.
|
|
|
|
If we find a contribution in violation of copyright it will be immediately removed. We will bar that contributor from the MonoGame.Extended project.
|
|
|
|
|
|
## Licensing
|
|
|
|
The MonoGame.Extended project is under the [MIT License](https://opensource.org/licenses/MIT) unless a portion of code is explicitly stated elsewhere. See the [LICENSE](LICENSE) for more details. Third-party libraries used by MonoGame.Extended are under their own licenses, we always seek permission from the original author of those libraries.. Please refer to those libraries for details on the license they use.
|
|
|
|
We accept contributions in "good faith" that it isn't bound to a conflicting license. By submitting a PR you agree to distribute your work under the MonoGame.Extended license and copyright.
|
|
|
|
|
|
## Need More Help?
|
|
|
|
If you need help, please ask questions in our [Discord](https://discord.gg/xPUEkj9), or you can ask questions in the official [MonoGame Discord](https://discord.gg/monogame).
|
|
|
|
|
|
Thanks for reading this guide and helping make MonoGame.Extended great!
|
|
|
|
:heart: The MonoGame.Extended Team
|