Bug reports and code and documentation patches are welcome.
It's important that you provide the full command argument list as well as the output of the failing command.
Use the --debug flag and copy&paste both the command and its output
to your bug report, e.g.:
$ fconv <COMPLETE ARGUMENT LIST THAT TRIGGERS THE ERROR> --debug
<COMPLETE OUTPUT>Before working on a new feature or a bug, please browse existing issues to see whether it has previously been discussed.
If you are fixing an issue, the first step should be to create a test case that reproduces the incorrect behaviour. That will also help you to build an understanding of the issue at hand.
Go to https://github.com/wf001/fconv and fork the project repository.
# Clone your fork
git clone [email protected]:<YOU>/fconv.git
# Enter the project directory
cd fconv
# Create a branch for your changes
git checkout -b my_topical_branchThe Makefile contains a bunch of tasks to get you started.
To get started, run the command below, which:
install all of dependencies.
make install-devtest
make check- Before running this command, recommend to create an isolated Python virtual environment inside
./venv(via the standard library venv tool);
source venv/bin/activatePlease make sure your changes conform to Style Guide for Python Code (PEP8)
and that make check passes.
Please add tests for any new features and bug fixes.
When you open a Pull Request, GitHub Actions will automatically run fconv’s test suite against your code, so please make sure all checks pass.