Skip to content

Latest commit

 

History

History
44 lines (30 loc) · 2.47 KB

CONTRIBUTING.md

File metadata and controls

44 lines (30 loc) · 2.47 KB
Raw

Contributing

  1. File an issue. The issue will be used to discuss the bug or feature and should be created before sending a CL.

  2. Install Go and configure correctly (https://golang.org/doc/install).

  3. Clone the repo: git clone https://github.com/OTA-Insight/bqwriter

  4. Change into the checked out source: cd bqwriter

  5. Fork the repo.

  6. Set your fork as a remote: git remote add fork [email protected]:GITHUB_USERNAME/bqwriter.git

  7. Make changes, commit to your fork. Please add a short summary and a detailed commit message for each commit.

  8. To minimize friction, consider setting Allow edits from maintainers on the PR, which will enable project committers and automation to update your PR.

  9. A maintainer will review the pull request and make comments.

    Prefer adding additional commits over amending and force-pushing since it can be difficult to follow code reviews when the commit history changes.

    Commits will be squashed when they're merged.

Testing

All tests can be run locally against the latest Go version (or whichever supported Go version you're using on your development machine):

go test -v ./...

These tests will also be run in our CI system (using GitHub Actions) on both the minimum supported Go version as well as the latest major Go version.

To see which versions these are checkout our README.

Contributor Code of Conduct

As contributors and maintainers of this project, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.

We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, or nationality.

This code of conduct applies both within project spaces and in public spaces when an individual is representing the project or its community.

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.

This Code of Conduct is adapted from the Contributor Covenant, version 1.2.0, available at https://contributor-covenant.org/version/1/2/0/