Skip to content

Latest commit

 

History

History
28 lines (18 loc) · 1.65 KB

CONTRIBUTING.md

File metadata and controls

28 lines (18 loc) · 1.65 KB

How to contribute to renku-data-services

Want to contribute to Renku? Thanks! There are many ways to help, and we very much appreciate your efforts.

The sections below provide guidelines for various types of contributions.

Bug Reports and Feature Requests

Do not report security issues as bugs, instead email us at [email protected]

Bugs and feature requests should be reported on GitHub Issues.

When reporting a bug, please include the following information:

  • Observed behavior
  • Expected behavior
  • Detailed steps to reproduce the bug.

Pull Requests

If you do not already have a development environment set up, you will probably find the developer documentation helpful.

  • Before submitting a pull request, please make sure you agree to the license and have submitted a signed contributor license agreement
  • PRs should include a short, descriptive title. The titles will be used to compile changelogs for releases, so think about the title in that context. The title should be formatted using the Conventional Commits style
  • Small improvements need not reference an issue, but PRs that introduce larger changes or add new functionality should refer to an issue
  • Structure your commits in meaningful units, each with an understandable purpose and coherent commit message. For example, if your proposed changes contain a refactoring and a new feature, make two PRs
  • Format commit messages using the Conventional Commits style