Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
36 lines (23 loc) · 1.31 KB

CONTRIBUTING.md

File metadata and controls

36 lines (23 loc) · 1.31 KB

Contributing

Thanks for your interest in contributing to nexus-collection-dl.

Reporting bugs

Use the Bug Report issue template. Include steps to reproduce, your OS, Python version, and any error output. The more detail, the faster we can fix it.

Suggesting features

Use the Feature Request issue template. Describe the feature and why you need it.

Asking questions

Head to Discussions for questions, troubleshooting, and general conversation. Issues are for bugs and feature requests only.

Development setup

git clone https://github.com/scottmccarrison/nexus-collection-dl.git
cd nexus-collection-dl
./setup.sh
source venv/bin/activate

You'll need a Nexus Mods API key to test against the API. See the README for details.

Pull requests

  • Create a feature branch off main
  • Use a descriptive branch name (e.g., fix-rar-extraction, add-dry-run-flag)
  • Keep changes focused. One PR per feature or fix.
  • Link the related issue if there is one
  • Test your changes locally before submitting

That's it. Nothing complicated.