Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
36 lines (26 loc) · 1.06 KB

CONTRIBUTING.md

File metadata and controls

36 lines (26 loc) · 1.06 KB

Contributing to n3ofetch

Thank you for considering contributing to n3ofetch — a Windows alternative to the popular Linux tool neofetch.

Ways to Contribute

  • Report bugs and issues
  • Suggest new features
  • Improve documentation
  • Submit pull requests

Workflow

  1. Fork the repository.
  2. Create a feature branch from main.
  3. Make your changes in small, focused commits.
  4. Ensure n3ofetch.bat runs without errors.
  5. Update documentation if behavior changes.
  6. Open a pull request with a clear description.

Code Guidelines

  • Keep the script pure Batch (.bat) with no external dependencies.
  • Prefer readability over clever tricks.
  • Use meaningful variable names.
  • Avoid deep nesting; keep logic blocks small and clear.
  • Comment non-trivial logic.

Pull Request Checklist

  • Code has been manually tested on at least one Windows system.
  • No new external dependencies were introduced.
  • Documentation (README/docs) updated where appropriate.
  • The change is minimal, focused, and well described.

Thank you for helping improve n3ofetch!