Skip to content

Latest commit

 

History

History
61 lines (37 loc) · 3.37 KB

CONTRIBUTING.md

File metadata and controls

61 lines (37 loc) · 3.37 KB
Raw

How to contribute to Poloniexlendingbot

Did you find a bug?

  • 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 and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

When making your report, be sure to mention:

  • Title: Short description of what the issue is. (The clearer the better.)
  • Label: Add the Bug label
  • Your configuration.cfg file. Be sure not to share your API key.
  • What version of the bot you are using.
  • What you think caused this issue. (On your end, you don't need to diagnose our code, tell us what you did that caused it.)
  • If you can, suggest a solution. (Again, you don't need to be technical in your description.)

Pat yourself on the back for being a productive contributor of an open source project.

Did you write a patch that fixes a bug, want to make a PR or want to change some of the code?

  • Please contribute using Github Flow. Create a branch, add commits, and open a pull request.

  • Please use the already made pull request template to layout your pull request.

  • Ensure the PR template is filled in fully and required conditions are met.

  • Adhere to the current code style outlined in the Documentation page.

  • If is all is good, wait for approvals by contributors which decide if your PR will be merged. The repo owner can also merge it in early if there is good reason to do so.

Pull request are made to be discussed, thus collaborators may want you to change things. Don't make a new PR for these changes. Update your existing PR.

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

Check if it's been suggested already here.

If it has, or something very similar has:

  • Check out the discussion on that suggestion.
  • If you feel you have more to add, then comment it there. Don't make a brand new issue for something that has already been suggested.

If it hasn't been suggested, suggest your change on Gitter if you need help or just create an issue.

Be sure to include in your report:

  • Title: A clear, short description of what you suggest. You can always go into detail in the description.
  • Information about your suggestion. (Does not need to be technical.)
  • Label: Add the Enhancement label.
  • Why you think this would improve the bot if added.
  • If you have Python experience, feel free to include snippets of code. (or even refer to a pull request or fork)

Pat yourself on the back. If your suggestion is added, you will be a productive contributor to an open source passion-powered project.

Do you have questions about the source code?

Poloniex lending bot is a volunteer effort and is a collaborative and fun project. We encourage you to pitch in and join the team!

Thanks,

Mikadily, Raanan, Evanito and other contributors.