Skip to content

Latest commit

 

History

History
61 lines (44 loc) · 2.2 KB

CONTRIBUTING.md

File metadata and controls

61 lines (44 loc) · 2.2 KB

Report issues

If you have any issue with AMS, sorry about that, I'll try to solve it asap. It would be better if you try to reinstall the program from the latest release and see if the bug is fixed.

If it is, check if the problem has not already been reported and if not, just open an issue on GitHub with the following basic information:

  • the output of ams --version .
  • your shell and its version (bash, zsh);
  • your system (Preferably Name from os-release);
  • how to reproduce the bug;
  • anything else you think is relevant.

It's only with enough information that I can do something to fix the problem.

Make a pull request

I'll gladly accept pull request on the official repository for new rules, new features, bug fixes, etc.

Developing

In order to develop locally, It would be better to setup a VM or a Container.

Develop using Virtual Machine

Develop using Ubuntu Container

A Dockerfile is added in the repository with preinstalled dependencies and tools. You can build and deploy it using docker cli.

Prerequisites

To use the container you require:

Full notes about installation are here

Running the container

Assuming you have the prerequisites and you git clone into home. :

  1. Change Directory (cd) into the repository.
cd ~/AMS
  1. Build the Custom Ubuntu Image.
docker build -t amsdev .
  1. Initialize and Run the container using the newly built image.
docker run -dit --name amsdev amsdev
  1. Open the container in VSCode and develop in the container.