mirror of
https://github.com/SwingTheVine/Wplace-BlueMarble.git
synced 2026-03-11 17:15:38 +00:00
Finished CONTRIBUTING.md
This commit is contained in:
SwingTheVine
parent
623091a2d5
commit
9461fbf6e6
2 changed files with 36 additions and 25 deletions
|
|
@ -33,9 +33,9 @@
|
|||
</table>
|
||||
|
||||
<h1>Contributing</h1>
|
||||
<a href="https://github.com/SwingTheVine/Wplace-BlueMarble/blob/main/LICENSE.txt" target="_blank"><img alt="Software License: MPL-2.0" src="https://img.shields.io/badge/Software_License-MPL--2.0-slateblue?style=flat"></a>
|
||||
<a href="https://github.com/SwingTheVine/Wplace-BlueMarble/blob/main/LICENSE.txt" target="_blank" rel="noopener noreferrer"><img alt="Software License: MPL-2.0" src="https://img.shields.io/badge/Software_License-MPL--2.0-slateblue?style=flat"></a>
|
||||
<p>
|
||||
Thank you for wanting to contribute to the userscript "Blue Marble"! It means a lot to me that someone likes my project enough to want to help it grow. If you haven't already done so, consider joining our Discord. You can ask questions about the mod there and receive feedback.
|
||||
Thank you for wanting to contribute to the userscript "Blue Marble"! It means a lot to me that someone likes my project enough to want to help it grow. If you haven't already done so, consider joining our Discord. You can ask questions about the userscript there and receive feedback.
|
||||
</p>
|
||||
|
||||
<h2>Summary</h2>
|
||||
|
|
@ -61,7 +61,7 @@
|
|||
<h2>What Can I Contribute?</h2>
|
||||
<h3>Programming</h3>
|
||||
<p>
|
||||
Most of the work to be done in this userscript is related to programming. It is helpful to have a background in programming, but not required. If you are looking to learn JavaScript and its syntax, check out this <a href="https://roadmap.sh/javascript" target="_blank">roadmap for learning JavaScript</a>. We strongly recommend that you understand functions, methods, classes, and Object-Oriented-Programming if you plan to implement a brand new feature. More technical knowledge like method chaining and lambda expressions are useful but not required.
|
||||
Most of the work to be done in this userscript is related to programming. It is helpful to have a background in programming, but not required. If you are looking to learn JavaScript and its syntax, check out this <a href="https://roadmap.sh/javascript" target="_blank" rel="noopener noreferrer">roadmap for learning JavaScript</a>. We strongly recommend that you understand functions, methods, classes, and Object-Oriented-Programming if you plan to implement a brand new feature. More technical knowledge like method chaining and lambda expressions are useful but not required.
|
||||
</p>
|
||||
<h3>Translation</h3>
|
||||
<p>
|
||||
|
|
@ -69,12 +69,12 @@
|
|||
</p>
|
||||
<h3>Everything Else</h3>
|
||||
<p>
|
||||
Although userscripts are oriented around coding, there are many ways to contribute! From improving the Wiki to making tutorials, you can contribute in many ways that don't require programming skills. For example, if you have an idea for a feature, submit it! Someone might see it, think it is cool, and implement it.
|
||||
Although userscripts are oriented around coding, there are many ways to contribute! From improving the README file, to making tutorials, you can contribute in many ways that don't require programming skills. For example, if you have an idea for a feature, but you don't have the skills to implement it, submit a feature request! Someone might see it, think it is cool, and implement it.
|
||||
</p>
|
||||
|
||||
<h2>What Can I Not Do?</h2>
|
||||
<p>
|
||||
Please do not use <a href="https://github.com/SwingTheVine/Wplace-BlueMarble/issues" target="_blank">GitHub Issues</a> for asking support questions (e.g. "How do I install this?" or "What does cssMangler do?"). We use the GitHub issue tracker for bug reports and feature requests. If you are having trouble and need help, ask on our <a href="https://discord.gg/tpeBPy46hf" target="_blank">Discord</a>. <b>However, you <i>should</i> make a feature request on our issue tracker before starting work on your contribution.</b> Nothing sucks more than working hard on a high-quality contribution just for it to be rejected because it does not align with the mission of the mod. Ask first!
|
||||
Please do not use <a href="https://github.com/SwingTheVine/Wplace-BlueMarble/issues" target="_blank" rel="noopener noreferrer">GitHub Issues</a> for asking support questions (e.g. "How do I install this?" or "What does <code>cssMangler</code> do?"). We use the GitHub issue tracker for bug reports and feature requests. If you are having trouble and need help, ask on our <a href="https://discord.gg/tpeBPy46hf" target="_blank" rel="noopener noreferrer">Discord</a>. <b>However, you <i>should</i> make a feature request on our issue tracker before starting work on your contribution.</b> Nothing sucks more than working hard on a high-quality contribution just for it to be rejected because it does not align with the mission of the mod. Ask first!
|
||||
</p>
|
||||
<p>
|
||||
Please contribute in good faith. We will reject pull requests with bad code, comments, or pull requests that damage the mod.
|
||||
|
|
@ -82,8 +82,8 @@
|
|||
|
||||
<h2>Guidelines</h2>
|
||||
<ul>
|
||||
<li>Always submit a <a href="https://github.com/SwingTheVine/QSAND-Minecraft/issues/new/choose" target="_blank">feature request</a> and receive authorization to work on your contribution <i>before</i> you start working on your contribution. This will save you time if we end up rejecting the contribution. Small contributions (like fixing spelling errors) don't need a feature request.</li>
|
||||
<li>Follow the <a href="https://github.com/SwingTheVine/QSAND-Minecraft/blob/1.8.9/docs/CODE_OF_CONDUCT.md" target="_blank">Code of Conduct</a>. This includes both your contributions and the way you interact with this community.</li>
|
||||
<li>Always submit a <a href="https://github.com/SwingTheVine/Wplace-BlueMarble/issues/new/choose" target="_blank" rel="noopener noreferrer">feature request</a> and receive authorization to work on your contribution <i>before</i> you start working on your contribution. This will save you time if we end up rejecting the contribution. Small contributions (like fixing spelling errors) don't need a feature request.</li>
|
||||
<li>Follow the <a href="https://github.com/SwingTheVine/Wplace-BlueMarble/blob/main/docs/CODE_OF_CONDUCT.md" target="_blank" rel="noopener noreferrer">Code of Conduct</a>. This includes both your contributions and the way you interact with this community.</li>
|
||||
<li>Always write a clear message that explains the changes. "Added some things" does <i>not</i> explain what was changed.</li>
|
||||
<li>Different feature, different pull request. If you submit a pull request for templates and localization (i18n) together, and we want to reject the localization, your template code is rejected along with the localization since they are the same pull request. They should be separate pull requests since they are separate features.</li>
|
||||
<li>The file structure must be maintained (unless you were authorized to change it). For example, all code should go in `src/` and all code affecting the overlay should go in the Overlay class file.</li>
|
||||
|
|
@ -93,28 +93,28 @@
|
|||
|
||||
<h2>Our Mission</h2>
|
||||
<p>
|
||||
Our "mission" makes up the essence of this mod. Without it, this project would not exist.
|
||||
Our "mission" makes up the essence of this userscipt. Without it, this project would not exist.
|
||||
</p>
|
||||
<p>
|
||||
The mission of this mod is to provide a well-documented, high-quality quicksand mod.
|
||||
The mission of this userscript is to provide a well-documented, high-quality, open-source template overlay.
|
||||
</p>
|
||||
<p>
|
||||
<ul>
|
||||
<li>We recognize that most Minecraft mods do not have high-quality quicksand. Most "quicksand" blocks out there have the same properties as cobwebs, just a different texture. This mod strives to fix that.</li>
|
||||
<li>We recognize that most quicksand mods do not allow their community to easily create their own types of quicksand. This mod strives to support additional blocks added by the community.</li>
|
||||
<li>We recognize that most Minecraft mods do not have enough documentation to allow their community to modify (or understand) the inner workings of the mod. This mod strives to be as beginner-friendly as possible.</li>
|
||||
<li>We recognize that most pixel canvas overlays do not have high-quality open-source code. Either the overlay is high-quality & close-sourced, or the overlay is low-quality & open-sourced. This userscript strives to fix that.</li>
|
||||
<li>We recognize that most pixel canvas overlay userscripts are obfuscated. While it is possible to modify them, it is unnecessarily challenging. This userscript hopes to change the precedence by being unobfuscated.</li>
|
||||
<li>We recognize that most pixel canvas overlay userscripts do not have enough documentation to allow their community to modify (or understand) the inner workings of the overlay. This userscript strives to be as beginner-friendly as possible.</li>
|
||||
</ul>
|
||||
</p>
|
||||
|
||||
<h2>How To Contribute</h2>
|
||||
<p>
|
||||
<ol>
|
||||
<li>Read all of the <a href="https://github.com/SwingTheVine/QSAND-Minecraft/blob/1.8.9/docs/CONTRIBUTING.md" target="_blank">contributing guidelines</a>.</li>
|
||||
<li>If you are contributing, submit a request <a href="https://github.com/SwingTheVine/QSAND-Minecraft/issues/new/choose" target="_blank">here</a>.</li>
|
||||
<li>Read all of the <a href="https://github.com/SwingTheVine/Wplace-BlueMarble/blob/main/docs/CONTRIBUTING.md" target="_blank" rel="noopener noreferrer">contributing guidelines</a>.</li>
|
||||
<li>If you would like to contribute, submit a request <a href="https://github.com/SwingTheVine/Wplace-BlueMarble/issues/new/choose" target="_blank" rel="noopener noreferrer">here</a>.</li>
|
||||
<li>If you have received authorization to start working on your contribution, set up the development environment on your device.</li>
|
||||
<li>Fork the project.</li>
|
||||
<li>Download your fork to the development environment.</li>
|
||||
<li>If applicable, it might be useful to learn how a (already in the mod) feature similar to your contribution works.</li>
|
||||
<li>If applicable, it might be useful to learn how a (already in the userscript) feature similar to your contribution works. For example, if you want to add a new popup window, it might be benifical to learn how the <code>Overlay</code> popup window works.</li>
|
||||
<li>Make your contribution.</li>
|
||||
<li>Commit to your fork.</li>
|
||||
<li>Submit a pull request between your fork and this project.</li>
|
||||
|
|
@ -123,13 +123,24 @@
|
|||
|
||||
<h2>Development Environment</h2>
|
||||
<p>
|
||||
Eclipse IDE: <br>
|
||||
<code>Version: Mars.1 Release (4.5.1)</code><br>
|
||||
<code>Build id: 20150924-1200</code><br>
|
||||
Java: <br>
|
||||
<code>Version: 8 Update 202</code><br>
|
||||
<code>Build id: 1.8.0_202-b08</code><br>
|
||||
Minecraft: <br>
|
||||
<code>Version: 1.8.9</code>
|
||||
<code>Gradle Mapping Version: 1.8.9-11.15.1.2318-1.8.9</code>
|
||||
This is what SwingTheVine uses to program Blue Marble. You don't have to use the exact same thing. This is provided for reference.
|
||||
|
||||
<h3>IDE</h3>
|
||||
Visual Studio Code<br>
|
||||
<code>Version: 1.102.3</code><br>
|
||||
|
||||
<h3>Browser</h3>
|
||||
Google Chrome<br>
|
||||
Version: <code>138.0.7204.184 (Official Build) (64-bit)</code><br>
|
||||
TamperMonkey Version: <code>5.3.3</code>
|
||||
|
||||
<h3>Operating System</h3>
|
||||
Windows 10 Home<br>
|
||||
Version: <code>22H2</code><br>
|
||||
OS Build: <code>19045.6093</code><br>
|
||||
Processor: <code>Intel Core i7-9750H CPU @ 2.60GHz</code><br>
|
||||
RAM: <code>16.0 GB</code><br>
|
||||
Storage: <code>932 GB SSD Samsung SSD 970 EVO Plus 1TB, 238 GB SSD HFM256GDJTNG-8310A</code><br>
|
||||
Graphics Card: <code>NVIDIA GeForce GTX 1660 Ti (6 GB)</code><br>
|
||||
System Type: <code>64-bit operating system</code>
|
||||
</p>
|
||||
|
|
|
|||
|
|
@ -140,7 +140,7 @@
|
|||
|
||||
<h2>How Versioning Works</h2>
|
||||
<p>
|
||||
The versioning system for this userscript follows the <a href="https://semver.org/" target="_blank">Semantic Versioning rules</a>. As such, it is formatted in an <code>X.Y.Z</code> format where:
|
||||
The versioning system for this userscript follows the <a href="https://semver.org/" target="_blank" rel="noopener noreferrer">Semantic Versioning rules</a>. As such, it is formatted in an <code>X.Y.Z</code> format where:
|
||||
<ul>
|
||||
<li>X is the major version. This is incremented when a non-backward compatible update is pushed. This is for new features that break previous versions of the userscript. Additionally, if wplace.live breaks the userscript, this will be incremented.</li>
|
||||
<li>Y is the minor version. This is incremented whenever I push to GitHub. This is for stable bug-fixes and new (non-breaking) features.</li>
|
||||
|
|
|
|||
Loading…
Reference in a new issue