Skip to content

Latest commit

 

History

History
75 lines (50 loc) · 3.31 KB

CONTRIBUTING.md

File metadata and controls

75 lines (50 loc) · 3.31 KB

Contributing to VisiData

Reporting bugs

If you encounter any bugs or have any problems, please create an issue on Github.

If you get an unexpected error, please include the full stack trace from Ctrl+E (you can save the trace with Ctrl+S).

Attach the commandlog (saved with Ctrl-D) to show the steps that led to the issue. Please include a small subset of the source data that elicits the problem.

Submitting code

VisiData has two main branches:

  • stable has the last known good version of VisiData (what is in pypi/brew/apt).
  • develop has the most up-to-date version of VisiData (which will eventually be merged to stable). All pull requests should be submitted against develop.

To set up a VisiData development environment:

  • git clone the repository.
  • git checkout the develop branch.
  • Set the PYTHONPATH environment variable to the toplevel visidata directory (export PYTHONPATH=. if running visidata from directory itself). This ensures that you are executing the code in the current checkout, instead of the global install (without needing to uninstall VisiData).

Contributing money

If VisiData has saved you time and effort, please contribute to my Patreon.

Talk about VisiData

The biggest thing you can do to help VisiData is to spread the word. Write blogposts, post tweets, mention it on podcasts. Be specific about how you use it and what you love about it.

Credits

Maintainers

Patrons

Thanks to the following people who have contributed financial support via Patreon.

  • Mike E

Contributors

Many thanks also to the following people for their contributions to VisiData:

Open Source License

VisiData is an open-source tool that can be installed and used for free (under the terms of the GPL3).

The core VisiData utility and rendering library will always be both free and libre.