Skip to content

Latest commit

 

History

History
62 lines (37 loc) · 2.69 KB

CONTRIBUTING.md

File metadata and controls

62 lines (37 loc) · 2.69 KB
Raw

CONTRIBUTING.md

Thank you for considering contributing to the PortIP project! Contributions are welcome from everyone, whether you're a beginner or an experienced developer.

Before contributing, please take a moment to review the following guidelines:

How to Contribute

  1. Fork the Repository: Start by forking the PortIP repository to your own GitHub account.

  2. Clone the Repository: Clone the forked repository to your local machine using the git clone command:

    git clone https://github.com/yourusername/portip.git

  3. Create a Branch: Create a new branch to work on your feature or bug fix:

    git checkout -b feature/my-feature

    Replace my-feature with a descriptive name for your feature.

  4. Make Changes: Make your desired changes to the codebase. Ensure your code follows the project's coding style and conventions.

  5. Test Your Changes: If applicable, test your changes thoroughly to ensure they work as expected.

  6. Commit Your Changes: Once you're satisfied with your changes, commit them to your forked repository:

    git add .
git commit -m "Add feature: My new feature"

  7. Push Changes: Push your changes to your fork on GitHub:

    git push origin feature/my-feature

  8. Open a Pull Request: Go to the PortIP repository on GitHub and open a pull request (PR) from your forked branch to the main branch of the original repository.

  9. Describe Your Changes: Provide a descriptive title and detailed description of the changes you've made in the PR description. Include any relevant information that would help reviewers understand the purpose and impact of your changes.

  10. Review and Collaborate: Collaborate with the maintainers and other contributors by responding to feedback, making necessary adjustments, and iterating on your changes until they're ready to be merged.

Code Style and Conventions

  • Follow the PEP 8 style guide for Python code.
  • Use meaningful variable and function names.
  • Write clear and concise comments to explain complex logic or algorithms.

Reporting Issues

If you encounter any bugs, issues, or have suggestions for improvements, please open an issue on GitHub. Provide as much detail as possible, including steps to reproduce the issue and your environment configuration.

Get in Touch

If you have any questions, suggestions, or just want to say hello, feel free to reach out to the project maintainers or community members via GitHub issues or discussions.

Thank you for contributing to PortIP! 🎉