Skip to content
This repository has been archived by the owner on Dec 15, 2018. It is now read-only.

Latest commit

 

History

History
102 lines (65 loc) · 6.52 KB

CONTRIBUTING.md

File metadata and controls

102 lines (65 loc) · 6.52 KB

Lawena Contributing Guide

First of all, thanks for reading this! There are lots of ways you can help, and if you do it following these guidelines, it will be useful for everyone and I'll gladly help you, reciprocating your respect.

Summary

If you need help or have questions, please use the issue tracker. If you're raising a bug please be sure to include as much info as possible so that can be fixed. If you've got some code you want to pull request please ask first and together we'll find a way to make it work.

Currently the only one actively developing Lawena Recording Tool is Quantic (github) (steam). Montz is no longer developing the tool so only bother him to thank him for starting the project. If you want to help in other ways, tell me about it via Steam or the Gitter chat.

Get involved

Tasks that need your help:

  1. Making sure Lawena does it's job — Sometimes I mess up after an update. Please let me know! Also anything not working out correctly, I'm always listening.
  2. Contributing to the GitHub Wiki — The wiki is a great place to collect helpful information regarding the tool. You only require a GitHub account to edit the wiki so I will greatly appreciate all contributions.
  3. Porting Lawena to other games — The tool can work out with most Source games with little modifications. If you are interested or want to suggest a game let me know.
  4. Helping with translations — Contact me on Steam for details.
  5. Increasing Linux/OSX support — Lawena supports those operating systems but the truth is that they are far from optimal. I'm looking for help especially about supporting OSX.

Using the issue tracker

The issue tracker is the preferred channel for bug reports, feature requests, change requests and submitting pull requests. I am always actively monitoring everything that happens there. That being said, I don't check forums too much.

Bug reports

A bug is a demonstrable problem that is caused by the code in the repository. Good bug reports are extremely helpful - thank you!

Guidelines for bug reports:

  1. Use the GitHub issue search — check if the issue has already been reported or even fixed to avoid duplicates. Don't forget searching closed issues.

  2. Include a screenshot or video if relevant - Is your issue about a design or front end feature or bug? Use LICEcap to quickly and easily record a short screencast (24fps) and save it as an animated gif! Embed it directly into your GitHub issue. If the issues happen while capturing frames, send me a YouTube link or the .dem file itself so we can test it together.

  3. Include as much info as possible! Use the Bug Report template below or click this link to start creating a bug report with the template automatically.

A good bug report shouldn't leave others needing to chase you up for more information. Please try to be as detailed as possible in your report. Any details will help people to fix any potential bugs.

Template:

Short and descriptive example bug report title

### Issue Summary

A summary of the issue and the game/OS environment in which it occurs. If
suitable, include the steps required to reproduce the bug.

### Steps to Reproduce

1. This is the first step
2. This is the second step
3. Further steps, etc.

Any other information you want to share that is relevant to the issue being
reported. Especially, why do you consider this to be a bug? What do you expect to happen instead?

### Technical details:

* Lawena Version: 4.2.0-pre.2-34 (check Help menu -> About for this)
* Game: TF2
* Your OS: Windows 8.1 64 bit
* Log file: Pastebin link or just paste the relevant lines

Feature Requests

I really like feature requests! Please use the issue tracker for this as well, stating that it's a feature request somewhere in there, after you do this:

  1. Visit the Roadmap & use the GitHub search to see if the feature has already been requested and then use the issue tracker to tell me about it.

  2. Please provide as much detail and context as possible, this means explaining the use case and why it is likely to be common.

Change Requests

Change requests cover both architectural and functional changes to how Lawena works. If you have an idea for a new or different dependency, a refactor, or an improvement to a feature, etc - please be sure to:

  1. Use the GitHub search and check someone else didn't get there first

  2. Consider the following:

    • Is it really one idea or is it many?
    • What problem are you solving?
    • Why is what you are suggesting better than what's already there?

And then use the issue tracker again for this.

Submitting Pull Requests

Pull requests (PR) are a really good feature to collaborate to the project directly with your code. For Lawena you can also create pull requests for changes to the included .cfg files, so you don't need to know how to program to help this way.

If you're looking to raise a PR for something which doesn't have an open issue, please think carefully about raising an issue which your PR can close, especially if you're fixing a bug. This makes it more likely that there will be enough information available for your PR to be properly tested and merged. The project is small so just submit the pull request and we'll make it work together!

Use Steam for stuff not covered here. Issue tracker and Gitter chat for random questions also works.