Skip to content

Latest commit

 

History

History
62 lines (43 loc) · 2.67 KB

CONTRIBUTING.md

File metadata and controls

62 lines (43 loc) · 2.67 KB

Contributing to go-opendistro

Code of Conduct

Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.

Our Standards

Examples of behavior that contributes to creating a positive environment include:

  • Using welcoming and inclusive language
  • Being respectful of differing viewpoints and experiences
  • Gracefully accepting constructive criticism
  • Focusing on what is best for the community
  • Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

  • The use of sexualized language or imagery and unwelcome sexual attention or advances
  • Trolling, insulting/derogatory comments, and personal or political attacks
  • Public or private harassment
  • Publishing others' private information, such as a physical or electronic address, without explicit permission
  • Other conduct which could reasonably be considered inappropriate in a professional setting

Open Development

The whole work on this project happens directly on github. Each pull request will go through the same review request.

Sending a pull request

If you are new in the open source community, you can learn how to contribute and create your first pull request by walking through How to Contribute to an Open Source Project on GitHub.

We are checking pull request frequently and either merge it, request a change or close it with an explanation.

Follow these steps before you submit a pull request:

  1. For the repository and create your branch from master
  2. Run export GO111MODULE=onand go get to download all dependencies
  3. Implement you feature, fix your bug and add tests if there is something new to test.
  4. Run go fmt
  5. Run go test
  6. Run go vet

Reporting Bugs, New Issues, Proposing a Change

Please feel free to report any issue on Github Issues. Before filing a new task, try to make sure your problem doesn’t already exist.

For security bugs please do not file a public issue on Github Issues. Write to [email protected] or write us in our Community Slack Channel

License

By contributing to go-opendistro, you agree that your contributions will be licensed under its MIT license.