canonical / kubeflow-rocks

Rocks for Kubeflow components
Apache License 2.0
0 stars 10 forks source link

Add "Contributing" section to README.md #123

Open mvlassis opened 2 months ago

mvlassis commented 2 months ago

Context

Since we welcome PRs from all developers, we should add a section to the main README.md file about contributing to this repository. This section should guide developers and help them avoid common issues, for example making sure that commits are made to the proper branch (e.g. here).

We can also encourage developers to write comprehensive descriptions of what they are improving/fixing with their PR.

Finally, we could add a section about the proper way to submit bugs, for example specifying how to post comprehensive logs of the error/output.

What needs to get done

Definition of Done

The README.md has a new section named "Contributing", with notes that help developers contribute/submit issues to the repository.

syncronize-issues-to-jira[bot] commented 2 months ago

Thank you for reporting us your feedback!

The internal ticket has been created: https://warthogs.atlassian.net/browse/KF-6052.

This message was autogenerated