-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
10 additions
and
29 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 |
---|---|---|
|
@@ -3,46 +3,32 @@ Contributing | |
|
||
I'm currently accepting contributions to this project. | ||
|
||
The codebase on GitHub is a mirror of the version on my | ||
[VCS](https://git.th3-z.xyz/kf2-magicked-admin). Please clone the version from | ||
my VCS, instructions in `README.md`, as this is the cannonical version. | ||
|
||
The `ISSUES.md` file contains an incomplete list of know issues, this includes | ||
planned features and bugs. | ||
|
||
I can be contacted by [email](mailto:[email protected]) or on | ||
[Steam](https://steamcommunity.com/id/th3-z), either is fine. | ||
|
||
How can I contribute? | ||
--------------------- | ||
|
||
Clone the current master branch and gave a go at some of the following tasks. | ||
The binaries on the release page are not useful to contributors, they are out | ||
of date. Tasks, in order of increasing complexity. | ||
|
||
- Bug reports are needed right now. There are no plans to add new features | ||
until master is stable. | ||
* You will need a Killing Floor 2 server for testing. | ||
* Testing on multiple servers. This tools can manage multiple servers at | ||
once, I only have one. | ||
* Please don't send me bug reports for the releases (0.0.7). These are out | ||
* Please don't raise issues for release 0.0.7. This release is out | ||
of date. | ||
- Translations. The project needs translators, please contact me if you can | ||
help with this. | ||
- Linting. I have added a make target that runs a linter, `make lint`. Running | ||
this will give you a huge list (200+) of minor code style errors. I want this | ||
to return no issues. | ||
- Debugging. Check the bugs in `ISSUES.md`, see if you can replicate them, and | ||
fix them. Send me patches via email. If you find an issue you can't correct, | ||
please add it to the `ISSUES.md` and send me a patch. | ||
- Feature additions. I'm not focussing on new features right now, but if you | ||
can't help yourself, see `ISSUES.md`. | ||
- Debugging. Check the bugs on the issue tracker, see if you can replicate them, and | ||
try to fix them. | ||
|
||
Code | ||
---- | ||
|
||
If you wish to contribute code, please see `ISSUES.md` for the current task | ||
list. Once you've completed a task, update the `ISSUES.md` file and send me a | ||
[patch](https://git-scm.com/docs/git-format-patch) with your changes by | ||
[email](mailto:the\_[email protected]). | ||
If you wish to contribute code, please see the issue tracker for the current | ||
task list. Once you've completed a task, raise a pull request. | ||
|
||
The `README.md` file has further details about dependencies and configuring | ||
your environment. | ||
|
@@ -52,12 +38,10 @@ N.b. all contributions will be released under the MIT license. | |
Bug Reports | ||
----------- | ||
|
||
All issues, including bugs, are tracked in the `ISSUES.md` file. Bug reports | ||
can be submitted by email to the [author](mailto:the\_[email protected]) or relevant | ||
contributor. Good bug reports should include the following. | ||
All issues, including bugs, are tracked in the issues tab. Good bug reports | ||
should include the following. | ||
|
||
* Clear and descriptive title. | ||
* Version of the software you are using. | ||
* Exact steps to reproduce the bug. | ||
* What is observed after following the steps. | ||
- Pastes of output or screenshots are helpful. | ||
|
@@ -67,17 +51,14 @@ contributor. Good bug reports should include the following. | |
- Operating system. | ||
- Configuration file, please censor any credentials. | ||
|
||
If you could include a patch that appends your issue to `ISSUES.md`, that would | ||
be helpful too, otherwise I can add it. | ||
|
||
Style | ||
----- | ||
|
||
### Commit messages | ||
* Imperative present tense. | ||
* 50 character first line. | ||
- Capitalise first character, no period. | ||
* Further details in description. | ||
* Further details in commit description. | ||
* No emoji. | ||
|
||
### Python | ||
|