Skip to content
This repository has been archived by the owner on Feb 27, 2024. It is now read-only.

Latest commit

 

History

History
25 lines (18 loc) · 1.2 KB

CONTRIBUTING.md

File metadata and controls

25 lines (18 loc) · 1.2 KB

Contributing to NgrokGUI

First off, thanks for taking the time to contribute! ❤️

And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:

  • Star the project
  • Tweet about it
  • Refer this project in your project's readme
  • Mention the project at local meetups and tell your friends/colleagues

Before working on a new feature

  • Tell us about the feature you wanna make so we can make sure your idea fits with the scope and aims of the project. It would be a waste if your and our time if it does not fit.

Pull Requests

For changes that address core functionality or would require breaking changes (e.g. a major release), it's best to open an Issue to discuss your proposal first.

In general, we follow the "fork-and-pull" Git workflow

  1. Fork the repository to your own Github account
  2. Clone the project to your machine
  3. Create a branch locally with a succinct but descriptive name
  4. Commit changes to the branch
  5. Push changes to your fork
  6. Open a PR in our repository, so we can efficiently review the changes.