Adds contributing.md #151
Adds contributing.md #151
Conversation
|
There is room for improvement but I think this is a solid starting off point. |
zavdav
left a comment
zavdav
left a comment
There was a problem hiding this comment.
I'm pretty sure the convention is that CONTRIBUTING.md is written in all-caps.
Also left some comments throughout the file
|
|
||
| - Line Endings: LF only | ||
|
|
||
| - Imports: Group Bukkit imports under // CraftBukkit start comments |
There was a problem hiding this comment.
This is just my personal opinion, but I don't think we should be required to mark new imports with comments
There was a problem hiding this comment.
Yeah, this was made more as a starting point going off issue 127 with what it seemed Johny wanted for the repo.
|
|
||
| ### Legal Requirements Code Provenance | ||
| ```` | ||
| Preserve original CraftBukkit (GPL v3) headers |
There was a problem hiding this comment.
There are currently no file headers in any of the CraftBukkit/Poseidon files, so these would have to be added at some point
There was a problem hiding this comment.
That was one of the things brought up in issue #127
| - **Easier Updates**: Smaller diffs simplify merging upstream changes from CraftBukkit/Mojang code in the unlikely case it is needed. | ||
| - **Beta Accuracy**: Maintains original physics, protocols, and behavior expected in Beta 1.7.3. | ||
| - **Conflict Prevention**: Reduces merge headaches. | ||
| - **Legibility**: Clearly separates Poseidon changes from CraftBukkit CB1060 code using `// ProjectPoseidon` markers. |
There was a problem hiding this comment.
See above for my proposed format for Poseidon comments
2 participants
Adds a contribution.md as noted in issue #127