go-or-no-go 0.1.0a2

Pre-commit hooks to check that your contributions meet project guidelines and the mission to merge is good to go!

Go or NO GO

Pre-commit hooks to check that your contributions meet project guidelines and the mission to merge is good to go! :saluting_face:

---

POWERED BY

:sunrise_over_mountains: Purpose & Function

Go or NO GO (gng for short) is a simple Python application designed to validate compliance to your project's guidelines.

:star_struck: Standout Features

We are currently in the Planning stage of the project, still defining the scope of the first milestones and our development plan. However, we anticipate the following features to be delivered for users at some point in the future:

• :snake: Configuration via pyproject.toml;
• :warning: A pre-commit hook to validate the size of changes in your branch;
• :fox: Check if your Git trailers comply with your GitLab changelog_config.yml categories.

:inbox_tray: Installation

Use pipx to install Go or NO GO in an isolated environment:

pipx install go-or-no-go

Then you can run it from the command line:

gng --help

:black_joker: How to Use It

The top-level command is the entry point for additional operations:

gng [--version | -v]

--version

-v

Print the current version of the program and exit.

:reminder_ribbon: Contributing

There are several ways to contribute to Go or NO GO. Refer to our CONTRIBUTING guide for all relevant details.

Currently, we are seeking help to tackle areas of focus that are more pressing to our project's progress and would make an immediate difference in helping us achieve our mission.

Here are some key contributions your can help us with right now:

• Provide input in design discussions to define the desired features of Go or NO GO.

:ship: Releases

You can see the list of available releases on the GitLab Releases page.

We follow Intended Effort Versioning specification, details can be found in our CONTRIBUTING guide.

:shield: Licence

This project is licenced under the terms of the MIT License. See LICENCE for more details.

:page_with_curl: Citation

We provide a CITATION.cff file to make it easier to cite this project in your paper.

Credits

This project was generated with Galactipy.