-
Notifications
You must be signed in to change notification settings - Fork 29
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added a licence and contributing file
- Loading branch information
1 parent
5585044
commit 0714bd4
Showing
2 changed files
with
69 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
This is not a licence but is guidance on what the final licence will and will not allow. | ||
|
||
Definitions | ||
Amulet-NBT - A low level NBT editing library. | ||
PyMCTranslate - A data translation library for Minecraft data. | ||
Amulet-Core - The world editing library. | ||
Minecraft-Model-Reader - A library to parse the resource pack model format. | ||
Amulet-Map-Editor - The repository containing the user facing program. | ||
Amulet Map Editor - The above repositories combined into a standalone user facing program. | ||
|
||
|
||
"Amulet" refers to a number of codebases that make up Amulet Map Editor. | ||
These include Amulet-Map-Editor, Amulet-Core, Amulet-NBT, PyMCTranslate and Minecraft-Model-Reader | ||
|
||
Can I redistribute or rehost any part of your code? | ||
No. Unless the code is explicitly licensed to allow otherwise, you cannot redistribute or rehost any code from Amulet. | ||
This includes the code in both source and compiled forms. | ||
The only exception to this is forking the original repository with the aim to modify or improve on the code. | ||
Imports and API calls are not included as part of this because they are necessary for external code to work. | ||
Can I use any part of Amulet as part of another program? | ||
Personal non-commercial projects are allowed to use any part of Amulet's codebase. | ||
Can I modify any part of Amulet? | ||
You are allowed to modify Amulet however you like. | ||
If you want to make improvements we accept code submissions through pull requests. | ||
Note that by submitting code you are giving us permission to host, distribute and use the code under the licence in its final form. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
## Contributing | ||
|
||
If you wish to report a bug in the program or suggest a feature please first [search the existing bugs and features](https://github.com/Amulet-Team/Amulet-Core/issues) to see if it already exists. | ||
If not [create a new issue](https://github.com/Amulet-Team/Amulet-Core/issues/new/choose). | ||
|
||
### Licence | ||
In order to contribute to the project you must agree that your submission can be used, hosted | ||
and redistributed for use by others under the terms of the [licence](LICENCE) for the project. | ||
Upon creating a pull request you will be asked to confirm that you acknowledge this. | ||
|
||
### Branch Naming | ||
A branch must be created in order to contribute code to the project. | ||
Unless you have permissions to create branches in Amulet-Team you will first need to [fork the repository](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo). | ||
You must then create a branch with an identifiable name using the following convention: | ||
|
||
* For features, use: `impl-<feature name>` | ||
* For bug fixes, use: `bug-<bug tracker ID>` | ||
* For improvements/rewrites, use: `improv-<feature name>` | ||
* For prototyping, use: `proto-<feature name>` | ||
|
||
### Tests | ||
There are a number of tests to make sure that the code behaves correctly. | ||
If you are making changes to the code these should be run before creating the pull request. | ||
|
||
### Code Formatting | ||
For code formatting, we use the formatting utility [black](https://github.com/ambv/black). | ||
To run it on a file, run the following command from your favorite terminal after installing: `black <path to file>` | ||
|
||
While formatting is not strictly required for each commit, we ask that after you've finished your | ||
code changes for your Pull Request to run it on every changed file. | ||
|
||
The following command will run it on all files. `black .` | ||
|
||
### Pull Requests | ||
Once you have added the desired changes and run tests and formatting you will need to [create a pull request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request). | ||
We ask that submitted Pull Requests give moderately detailed notes about the changes and explain | ||
any changes that were made to the program outside of those directly related to the feature/bug-fix. | ||
|
||
Once a Pull Request is submitted, we will mark the request for review. | ||
Once that is done, we will review the changes and may provide feedback on things to change. | ||
Once all additional changes have been made, we will merge the request. | ||
|
||
The tests and code formatting will be run automatically when the pull request is created to verify that everything is okay. | ||
This can be seen at the bottom of the pull request page. |
0714bd4
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
License*
0714bd4
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also, the proposed limitations are kind of unfortunate :/
0714bd4
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks. Looks like an Americanism. The noun in British English is "licence" but the verb is "license"
I will need to fix this