Skip to content

Latest commit

 

History

History
48 lines (37 loc) · 2.49 KB

CONTRIBUTING.md

File metadata and controls

48 lines (37 loc) · 2.49 KB

🤝 Contribution Guide

Thank you for your interest in contributing to FediViz, in this document you can find guidelines for how to do so.

Before starting, it's recommended you check out the Resources section of our docs as these include information about the tools and libraries used, alongside helper files for getting you started.

Why this guide?

By following these guidelines you help to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.

What you can contribute with

FediViz is an open-source project, that greatly appriciates contributions from our community (You!). There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests or writing code which can be incorporated into the project itself.

Our Rules

Is based of the Python Community Code of Conduct and are here to equally respect the maintainers, contributers and their time.

For those who intend to contribute code, we also ask that you:

  • Start by writing a labelled issue containing:
    • A descriptive title
    • A detailed explanation of the issue.
  • Keep feature versions as small as possible, preferably one new feature per pull-request.
  • Keep commits clean by following Conventional Commits
  • All pull-requests must adhere to the quality standard of the project by:
    • Passing all quality gates (Deepsource)
    • Being approved by a maintainer

Your First Contribution

Depending on the type(tag) of issue, you may then either request it, assistance or implement it yourself.

How to contribute code

In order to contribute code, you must do the following:

  • Creating a branch from main called {TAG}/{ISSUE_ID}-{NAME-OF-YOUR-FEATURE}
    • Example: feat/28-post-render-Component
    • Example: docs/32-setup-resources
    • Example: bug/38-streamlit-env-loading
  • Setting up the provided ➡️ Resources
  • Implement your changes
  • Create a pull-request to develop ➡️ Here

How to report a bug

Follow the provided template when opening a new issue.

How to suggest a feature or enhancement

Follow the provided template when opening a new issue.