First of all, thank you for wanting to contibute to a Hyperdriven project! 🙌
We welcome and encourage contibutions (no matter how big or small) from everyone. By participating, you agree to abide by our code of conduct.
- Submit a Pull Request
- Edit the Wiki 📝
- Report a Bug 🪲
- Suggest a Feature 💡
- Tell Me about a project you used this in. 📬
- Write about us on your blog or social media! 📣
-
Clone your fork:
git clone git@github.com:your-username/logbeat.git
-
Set up your machine:
./scripts/setup
-
Install dependencies:
./scripts/install
-
Make sure the tests pass:
./scripts/test
-
Make your change. Add tests, and ensure the tests pass:
./scripts/test
-
Commit your changes (squash your commits, if needed), push your fork, and submit a pull request
At this point you're waiting on us. We will try to review your submissions within three days -- typically sooner than that. We may suggest some changes, improvements or alternative approaches -- please be open to feedback, as we have to consider how your change fits into the over all design and vision of the project.
Some things that will increase the chance that your pull request is accepted:
- Break unrelated changes up into multiple pull requests -- our change log is generated automatically from merged pull requests.
- Add your changes to one of the existing files in our package, unless you are introducing an entirely new concept (in which case, you can create a new file).
- Write tests. We use testify for our unit tests.
- Follow the Golang style guide.
- Write a good commit message.