Skip to content

Latest commit

 

History

History
35 lines (25 loc) · 3.15 KB

CONTRIBUTING.md

File metadata and controls

35 lines (25 loc) · 3.15 KB
Raw

Contributing to tview

First of all, thank you for taking the time to contribute.

The following provides you with some guidance on how to contribute to this project. Mainly, it is meant to save us all some time so please read it, it's not long.

Please note that this document is work in progress so I might add to it in the future.

Issues

  • Please include enough information so everybody understands your request.
  • Screenshots or code that illustrates your point always helps.
  • It's fine to ask for help. But you should have checked out the documentation first in any case.
  • If you request a new feature, state your motivation and share a use case that you faced where you needed that new feature. It should be something that others will also need.

Pull Requests

In my limited time I can spend on this project, I will always go through issues first before looking at pull requests. It takes a lot of time to look at code that you submitted and I may not have that time. So be prepared to have your pull requests lying around for a long time.

Therefore, if you have a feature request, open an issue first before sending me a pull request, and allow for some discussion. It may save you from writing code that will get rejected. If your case is strong, there is a good chance that I will add the feature for you.

I'm very picky about the code that goes into this repo. So if you violate any of the following guidelines, there is a good chance I won't merge your pull request.

  • There must be a strong case for your additions/changes, such as:
    • Bug fixes
    • Features that are needed (see "Issues" above; state your motivation)
    • Improvements in stability or performance (if readability does not suffer)
  • Your code must follow the structure of the existing code. Don't just patch something on. Try to understand how tview is currently designed and follow that design. Your code needs to be consistent with existing code.
  • If you're adding code that increases the work required to maintain the project, you must be willing to take responsibility for that extra work. I will ask you to maintain your part of the code in the long run.
  • Function/type/variable/constant names must be as descriptive as they are right now. Follow the conventions of the package.
  • All functions/types/variables/constants, even private ones, must have comments in good English. These comments must be elaborate enough so that new users of the package understand them and can follow them. Provide examples if you have to. Start all sentences upper-case, as is common in English, and end them with a period. Comments in their own lines must not exceed the 80 character border. Break over if necessary.
  • A new function should be located close to related functions in the file. For example, GetColor() should come after (or before) SetColor().
  • Your changes must not decrease the project's Go Report rating.
  • No breaking changes unless there is absolutely no other way.
  • If an issue accompanies your pull request, reference it in the PR's comments, e.g. "Fixes #123", so it is closed automatically when the PR is closed.