UNPKG

node-pkill-process

Version:

A CLI tool to list and kill background Node.js processes

61 lines (43 loc) 2.03 kB
# Contributing to Node PKill Process Thank you for your interest in contributing to Node PKill Process! This document provides guidelines and instructions for contributing to this project. ## Code of Conduct Please review and follow our [Code of Conduct](CODE_OF_CONDUCT.md) to help create a welcoming and inclusive environment for everyone. ## How to Contribute There are many ways to contribute to this project: - Reporting bugs - Suggesting new features - Improving documentation - Contributing code fixes - Adding new features - Writing tests - Reviewing pull requests ## Reporting Issues When reporting issues, please include: 1. A clear title and description 2. Steps to reproduce the problem 3. Expected behavior 4. Actual behavior 5. Environment information (OS, Node.js version, etc.) 6. Any relevant logs or screenshots ## Development Setup 1. Fork the repository 2. Clone your fork: `git clone https://github.com/YOUR_USERNAME/node-pkill-process.git` 3. Navigate to the project directory: `cd node-pkill-process` 4. Install dependencies: `npm install` 5. Run the project: `npm start` ## Pull Request Process 1. Create a new branch for your feature or bug fix: `git checkout -b feature/your-feature-name` or `git checkout -b bugfix/your-fix-name` 2. Make your changes 3. Ensure your code follows the project's style and passes all tests 4. Commit your changes using clear, descriptive commit messages 5. Push your branch to your fork: `git push origin feature/your-feature-name` 6. Open a pull request to the `main` branch of the original repository ## Code Style - Write clear, readable code with meaningful variable names - Comment your code where necessary, especially for complex logic - Follow existing code style and patterns - Use consistent indentation (2 spaces) - Run `npm test` to ensure your changes don't break existing functionality ## Questions? If you have any questions about contributing, feel free to open an issue or contact the maintainers. Thank you again for your contribution!