Skip to content

Latest commit

 

History

History
49 lines (30 loc) · 1.81 KB

CONTRIBUTING.md

File metadata and controls

49 lines (30 loc) · 1.81 KB
Raw

Contributing to Speedle Project

We welcome your contributions! There are multiple ways to contribute.

Promotion

If you like Speedle project, please let your colleagues/friends know the project. You may consider to star the project at Github. So that more people can find the project.

And sharing us your success story with Speedle would be greatly appreciated if you don't mind.

Discussion

Join us at speedle-users and/or speedle-developers groups.

Join us at #speedleproject

Issues

If you hit a bug or have an enhancement request then file a GitHub issue.

If you report a bug, please include:

  1. Version of Speedle
  2. Issue Description
  3. Reproducible Environment and Steps
  4. Expected behavior

Code

We welcome code contributions, but we need the contributor to sign the Oracle Contributor Agreement (OCA) first.

The process:

  1. Sign the OCA
  2. Fork the repo
  3. Fix an issue or create an issue and fix it
  4. Create a Pull Request that fixes the issue
  5. Watch your PR for pipeline results. If there are failures then fix them.
  6. We will review your PR and merge as appropriate.

Code of Conduct

Follow the Golden Rule. If you'd like more specific guidelines see the Contributor Covenant Code of Conduct