Skip to content

Contributing to pan-scm-sdk

We're thrilled that you're interested in contributing to the pan-scm-sdk project! Your contributions are essential for making this project better and more effective. Whether you're fixing a bug, adding a new feature, improving the documentation, or just giving suggestions, every contribution is valuable.

Getting Started

Before you begin, make sure you have a GitHub account and are familiar with Git and GitHub workflows. If you're new to these tools, you might want to check out some tutorials on GitHub's Help pages.

Setting Up Your Environment

  1. Fork the Repository: Start by forking the pan-scm-sdk repository on GitHub.

  2. Clone Your Fork: Clone your fork to your local machine:

git clone https://github.com/yourusername/pan-scm-sdk.gitcd pan-scm-sdk
  1. Create a Branch: Create a new branch for your feature, fix, or improvement:
git checkout -b feature/YourFeatureName
  1. Set Up the Development Environment: Follow the Getting Started guide to set up your local development environment.

Making Changes

  1. Make Your Changes: Add your changes or improvements to the codebase. Keep your code clean and well-commented.

  2. Test Your Changes: Ensure that your changes do not break any existing functionality. Add tests if necessary.

  3. Commit Your Changes: Once you're happy with your changes, commit them:

git commit -am "Add some AmazingFeature"

Submitting a Contribution

  1. Push to Your Fork: Push your branch to your GitHub fork:
git push origin feature/YourFeatureName

  1. Create a Pull Request: Go to the original pan-scm-sdk repository on GitHub and create a new pull request. Provide a clear description of your changes and any relevant issue numbers.

  2. Code Review: Wait for a review from the project maintainers. Be open to feedback and make any requested changes.

Contribution Guidelines

  • Code Style: Follow the existing coding style and conventions. We use Black for Python code formatting.
  • Documentation: Update the documentation to reflect any changes, especially if adding new features or changing existing functionality.
  • Respect: Treat other contributors with respect. We're all working towards the same goal!

Questions or Need Help?

If you have any questions or need help with your contribution, don't hesitate to reach out via GitHub Issues or our contact email.

We're excited to see your contributions and to welcome you to our community!

Back to Top