Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
59 lines (41 loc) · 2.1 KB

CONTRIBUTING.md

File metadata and controls

59 lines (41 loc) · 2.1 KB

Contributing to Node Version Switch

Thank you for your interest in contributing to Node Version Switch, a lightweight Node.js version manager for Windows! Your help is greatly appreciated in making this project better.

How to Contribute

Reporting Issues

Found a bug, have a feature request, or want to suggest an improvement?

  1. Check the GitHub Issues to avoid duplicates.
  2. Open a new issue with:
    • A clear and descriptive title.
    • Steps to reproduce (if a bug).
    • Your environment (e.g., Windows 10/11, PowerShell 5.1 or 7+).

Submitting Pull Requests

To contribute code or documentation:

  1. Fork the repository and create a branch: 
    git checkout -b feature/your-feature
  2. Make your changes, adhering to the guidelines below.
  3. Commit with a clear message: 
    git commit -m "Add your feature or fix"
  4. Push to your fork: 
    git push origin feature/your-feature
  5. Open a Pull Request, including:
    • A description of your changes and their purpose.
    • References to related issues (e.g., "Fixes #123").

Contribution Guidelines

  • Code Style: Use clear variable names, add comments for complex logic, and follow PowerShell best practices.
  • Documentation: Update README.md or other docs if your change affects usage or commands.
  • Testing: Test on Windows 10/11 with PowerShell 5.1 or 7+. Verify core commands (nvs install, nvs use, nvs uninstall).
  • Scope: Keep changes focused. Discuss major features in an issue first.

Getting Help

Questions or need guidance?

  • Open an issue with the "question" label.
  • Contact the maintainer via GitHub or LinkedIn.

Note: Contributions and questions in Portuguese are welcome! Feel free to reach out in your preferred language.

Code of Conduct

Please be respectful and inclusive. We strive to maintain a welcoming and collaborative environment.

Thank you for helping improve Node Version Switch!