CONTRIBUTING.md

How to contribute

Create a new issue using the correct issue template or introduce a new feature/fix a bug and submit a pull request.

Catnap uses Semantic Versioning, make sure to bump the version respectively.

To bump the version, use the versionctl tool which can be generated using:

# Generate versionctl tool
$ nim generate_versionctl

# List usage of versionctl tool
$ versionctl

Remember to update the CHANGELOG.md file with any changes that impact end users.

Project structure

.
├── config/
│   ├── config.toml  # Main config
│   └── distros.toml # Distro art config
├── docs/  # Contains man docs
├── image/ # Contains all images for README.md
├── src/
│   ├── catnaplib/
│   │   ├── drawing/    # Files for rendering output
│   │   ├── generation/ # Files for generating output objects
│   │   ├── global/     # Files used globally
│   │   ├── platform/   # Files related to fetching system info
│   │   └── terminal/   # Files related to terminal stuff (Colors, Logging)
│   ├── extern/
│   │   ├── headers/   # Contains extern c++ headers (hpp)
│   │   └── libraries/ # Contains extern libs
│   └── catnap.nim # Entry src file
├── scripts/     # Test Scripts etc.
├── config.nims  # nim install, nim debug, ...
└── CHANGELOG.md # Changelog for current development version (versionctl print)

How to add a new distro

1. Add the distro's logo in the default distros.toml in the config/ folder. Please arrange the distro in alphabetical order.
2. In src/catnaplib/global/definitions.nim, go to the PKGMANAGERS section.
3. According to the name of the distro in config/distros.toml, put a new line like this:

"name of distro": "name of package manager",

4. If your distro's package manager is already in the PKGCOUNTCOMMANDS section, skip the next step.
5. Put your distro's package manager in the PKGCOUNTCOMMANDS section like this:

"name of package manager": "command to get number of packages",

6. Submit a pull request to the Catnap repo.