Skip to content

Latest commit

 

History

History
44 lines (32 loc) · 3.22 KB

CONTRIBUTING.md

File metadata and controls

44 lines (32 loc) · 3.22 KB

Contributing to Blox

Contributions to Blox should be made via GitHub pull requests and discussed using GitHub issues.

Before you start

If you would like to make a significant change, it's a good idea to first open an issue to discuss it.

Making the request

Development takes place against the dev branch of this repository and pull requests should be opened against that branch.

Code Style

This project follows the Google Java Styleguide, and this style is enforced as part of the check task. We recommend you install the google-java-format plugin for your IDE, or use the gradle spotlessApply task to format code before checking in.

Testing

Any contributions should pass all tests. You can run all tests by running gradle check from the project root.

Licensing

Blox is released under an Apache 2.0 license. Any code that you submit will be released under that license. For significant changes, we may ask you to sign a Contributor License Agreement.

Amazon Open Source Code of Conduct

This code of conduct provides guidance on participation in Amazon-managed open source communities, and outlines the process for reporting unacceptable behavior. As an organization and community, we are committed to providing an inclusive environment for everyone. Anyone violating this code of conduct may be removed and banned from the community.

Our open source communities endeavor to:

  • Use welcoming and inclusive language;
  • Be respectful of differing viewpoints at all times;
  • Accept constructive criticism and work together toward decisions;
  • Focus on what is best for the community and users.

Our Responsibility. As contributors, members, or bystanders we each individually have the responsibility to behave professionally and respectfully at all times. Disrespectful and unacceptable behaviors include, but are not limited to: The use of violent threats, abusive, discriminatory, or derogatory language;

  • Offensive comments related to gender, gender identity and expression, sexual orientation, disability, mental illness, race, political or religious affiliation;
  • Posting of sexually explicit or violent content;
  • The use of sexualized language and unwelcome sexual attention or advances;
  • Public or private harassment of any kind;
  • Publishing private information, such as physical or electronic address, without permission;
  • Other conduct which could reasonably be considered inappropriate in a professional setting;
  • Advocating for or encouraging any of the above behaviors.

Enforcement and Reporting Code of Conduct Issues. Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting [email protected]. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances.

Attribution. This code of conduct is based on the template established by the TODO Group and the Scope section from the Contributor Covenant version 1.4.