Contributing

The dynamic prompt project welcomes contributions from developers and user in the open source community. Contribution can be made in a number of ways, a few example are :

• Code patch via pull requests,
• Documentation improvements,
• Bug reports and patch reviews,
• Proposition of new features,
• etc.

Code of conduct

Everyone interacting in the dynamic prompt's codebases, issues trackers, etc. is expected to follow this Code of conduct.

Reporting an Issue

Please include as much details as you can when reporting an issue in the issue trackers. If the problem is visual (for instance, wrong segment display) please add a screenshot.

Testing the development version

If you want to just try out the dynamic prompt you can do it safely in a docker container by using the script test.sh provided in the repo. For more information, see Testing the prompt.

Running the tests

To run the tests, the easier way to do is to run the prompt in the docker container with the help of the script tools/test script provided in the repo. The run the following scripts that are in the folder ci/:

• shellcheck.sh: Will pass the shellcheck "linter" on all bash scripts of the repo

• ci.zsh/ci.bash: Will print v1 and v2 of the prompt for bash or zsh depending on the extension and will compute the average time to compute the prompt for 100 run.

For more information about these scripts, see CI Scripts Documentation.

Submitting Pull Requests

Once you are happy with your changes or you are ready for some feedback, push it to your fork and send a pull request¹. For a change to be accepted it will most likely need to have tests and documentation if it is a new feature.

For more information, you can check Developers Guidelines which provide you guidelines and a tutorial detailing a proposed workflow.