Skip to content

Latest commit

 

History

History
91 lines (70 loc) · 3.03 KB

CONTRIBUTING.md

File metadata and controls

91 lines (70 loc) · 3.03 KB

Contributing to Nmap-API

Thank you for your interest in contributing to Nmap-API! I appreciate your efforts to improve this project and welcome contributions to make it even better. This document outlines how you can contribute and collaborate effectively.

Table of Contents

  1. Code of Conduct
  2. How Can You Contribute?
  3. Reporting Issues
  4. Feature Requests
  5. Contributing Code
  6. Style Guide
  7. Submitting Pull Requests
  8. Community Support

Code of Conduct

By participating in this project, you agree to abide by the Code of Conduct. I aim to foster a welcoming and inclusive environment, and I expect all contributors to adhere to these principles.

How Can You Contribute?

You can contribute in the following ways:

  • Reporting bugs or issues.
  • Suggesting new features or improvements.
  • Submitting code contributions through pull requests.
  • Improving the documentation.

Reporting Issues

If you encounter any issues, please open an issue. Be sure to include:

  • A clear title and description of the problem.
  • Steps to reproduce the issue, if applicable.
  • Any relevant logs, error messages, or screenshots.

Feature Requests

Got an idea for a new feature? I'd love to hear about it! Please open a feature request here and provide as much detail as possible about:

  • The problem it solves.
  • How it would work.
  • Any potential challenges or considerations.

Contributing Code

If you'd like to contribute code, follow these steps:

  1. Fork the repository and clone your fork.
  2. Create a new branch for your feature or bug fix: 
    git checkout -b my-feature-branch
  3. Make your changes and commit them with clear messages: 
    git commit -m "Add: Feature description"
  4. Push your branch to your fork: 
    git push origin my-feature-branch
  5. Open a pull request (PR) to the main branch of this repository.

Style Guide

Please follow these guidelines for a consistent codebase:

  • Write clear and concise code.
  • Use meaningful commit messages.
  • Adhere to PEP 8 for Python code.
  • Ensure your code is well-documented with comments and docstrings.

Submitting Pull Requests

When submitting a pull request:

  • Provide a clear description of your changes and why they’re necessary.
  • Ensure your branch is up to date with the main branch before opening the PR.
  • Reference the issue number your PR addresses, if applicable.
  • Be open to feedback and willing to make revisions.

Community Support

If you have any questions or need assistance, feel free to open a discussion or contact me directly.

Thank you for your contributions and for helping improve Nmap-API!