Skip to content

Latest commit

 

History

History
42 lines (19 loc) · 2.69 KB

CONTRIBUTING.md

File metadata and controls

42 lines (19 loc) · 2.69 KB

How to contribute to liquipediapy

Hi, Firstly, thanks for wanting to help! as this project is parsing html pages it is gonna break as often as liquipedia updates it pages and I could use any help we can get to keep it alive.I Inititally was using the liquipedia API for some data collection and thought it would be cool to make it into a api everyone could use as liquipedia has a vast amount of information that could benifit a lot of developers.

I havent used any fixed coding convention ans as youll notice Ive used tabs instead of spaces, but if you do want to use a specified convention please use PEP8 and I will rewrite my code in PEP8 format as soon as I can.

Did you find a bug?

  • Firstly, please double-check the bug doesn't come from something on your side.

  • Then, ensure the bug was not already reported by searching on GitHub under Issues

  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title ,clear description and label as "bug", as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

  • Be sure to add the complete error messages or the output of the function that seemes to be broken.

Did you write a patch that fixes a bug?

  • Open a new GitHub pull request with the patch.

  • Ensure that your PR includes examples and doc changes if there are any

  • Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.

Do you intend to add a new feature or change an existing one?

  • You can suggest your change on the Issues with label "enhancement" to see if others are interested or want to help.

  • Once your approach has been discussed and confirmed on the thread, you are welcome to push a PR, or add your feature to the TODO file so that someone else can add this feature.

  • Ensure that your PR includes examples and doc changes if there are any

Do you have questions about the source code?

  • Please ask it on the Issues with label as "question" (after searching someone didn't ask the same one before with a quick search)