Skip to content

Latest commit

 

History

History
39 lines (29 loc) · 2.47 KB

CONTRIBUTING.md

File metadata and controls

39 lines (29 loc) · 2.47 KB
Raw

Contributing to Minicli

Thank you so much for your interest in contributing to Minicli! This document will give you some guidance on how to contribute and what we do expect from you as a contributor. Please notice these are guidelines, not rules, and you are always welcome to suggest changes to this document via a Pull Request.

How Can I Contribute?

There are many ways in which you can contribute to Minicli. Here are some ideas:

  • Reporting Issues / Bugs
  • Suggesting Improvements
  • Code
    • bug fixes and new features that are within the main project scope
    • bug fixes and new features on the Minicli ecosystem (application template, curly)
    • add-ons that can live in a separate package repository
    • CLI themes
    • improving test coverage
  • Documentation (lives in the docs repository)
    • corrections, new docs, improvements to the docs appearance
  • Demos (lives in the demos repository)

Apart from the main minicli/minicli package, the Minicli project has other repositories that you can contribute to. Most of the additional repositories are still experimental, working as add-ons to the main Minicli framework.

Pull Request Process

Contributing requires you to create a pull request. Here's what we expect from you:

  • Check if there are any available issues that you can work on.
  • If you want to propose a new feature or big change, it's a good idea to start a discussion or create an issue. We don't want you to spend your time on something that might eventually not get accepted. It's better if we can talk about it before you dedicate your time.
  • Be nice. We expect you to adhere to our code of conduct at all times, whether if you're filing an issue, contributing code, or commenting on existing issues and pull requests.
  • Provide enough information on the Pull Request's body - explain why and how.
  • Code standards: we follow PSR-12.
  • Make sure tests are passing.

Here's what you can expect from us:

  • Respectful and candid feedback 🤝
  • Help when you get stuck or need suggestions 🤲
  • We'll always try to accommodate your contribution, even if that means we'll make adjustments later 👍
  • Gratitude!!! 🙌