Contributing

If you found RuneManager interesting and want to contribute you are more than welcome to! There are different ways to contribute, but mainly you can submit issues or contribute code. However, to keep the project and repository clean and well-developed there are guidelines for how to do it properly.

Found an issue?

If you have encountered a problem with RuneManager, please make sure there are no errors on your end. Some ways to validating this is to properly clear your browser cache, clear the config and project cache, run a fresh migration or simply restart your web and database server.

If no errors are detected on your end you can submit an issue, or even better submit a Pull Request with a fix.

Submission guidelines

Submitting an issue

Please check if your issue is not a duplicate by searching existing issues

Read how to submit an issue if you are unfamiliar with that: https://help.github.com/en/articles/creating-an-issue

Provide the following information to make the issue clear and understandable:

Give a clear title

A clear title makes it easy to understand the problem.

Describe the problem

A clear and concise description of what the problem is.

To Reproduce

Steps to reproduce the behavior:

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

Expected behavior

A clear and concise description of what you expected to happen.

Screenshots

If applicable, add screenshots to help explain your problem.

Additional context

Add any other context about the problem here, e.g. logs or HTTP errors. Your Laravel logs can usually be found in ~/runemanager/storage/logs on Linux.

Contributing code

If you are interested in contributing code or develop RuneManager, there is plenty of room for you! Currently, there is pretty much need for anything, so if you are interested submit a Pull Request with your contribution or contact me: simon.k.lonnestad@gmail.com

If you want to work on an issue, assign yourself to the issue so we know what you are working with.

When contributing code, submit a Pull Request. If unfamiliar with that, please read about how here: https://help.github.com/en/articles/creating-a-pull-request

Code conventions

There are some conventions to follow to ensure consistency when creating code for RuneManager:

• Use tabs with four indents
• Brace placement is always on the same line
• Comments are placed on a seperate line
• camelCase