maride/gotty
1
0
Fork 0
mirror of https://github.com/sorenisanerd/gotty.git synced 2024-11-09 15:24:25 +00:00
Code Issues Packages Projects Releases Wiki Activity
2204b28af9
gotty/CONTRIBUTING.md
Søren L. Hansen 4e017f1618 Take over GoTTY maintainership 
@yudai built this amazing piece of software, but it now needs a new,
active maintainer. I'm taking a stab at it.
2021-04-10 21:46:31 -07:00

1.8 KiB
Raw Blame History

How to contribute

GoTTY is MIT licensed and accepts contributions via GitHub pull requests. We also accepts feature requests on GitHub issues.

Reporting a bug

Reporting a bug is always welcome and one of the best ways to contribute. A good bug report helps the developers to improve the product much easier. We therefore would like to ask you to fill out the quesions on the issue template as much as possible. That helps us to figure out what's happening and discover the root cause.

Requesting a new feature

When you find that GoTTY cannot fullfill your requirements because of lack of ability, you may want to open a new feature request. In that case, please file a new issue with your usecase and requirements.

Opening a pull request

Code Style

Please run go fmt on your Go code and make sure that your commits are organized for each logical change and your commit messages are in proper format (see below).

Go's official code style guide is also helpful.

Format of the commit message

When you write a commit message, we recommend include following information to make review easier and keep the history cleaerer.

  • What is the change
  • The reason for the change

The following is an example:

Add something new to existing package

Since the existing function lacks that mechanism for some purpose,
this commit adds a new structure to provide it.

When your pull request is to add a new feature, we recommend add an actual usecase so that we can discuss the best way to achive your requirement. Opening a proposal issue in advance is another good way to start discussion of new features.

Contact

If you have a trivial question about GoTTY for a bug or new feature, you can contact @sorenisanerd on Twitter (unfortunately, I cannot provide support on GoTTY though).