Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
53 lines (34 loc) · 2.97 KB

CONTRIBUTING.md

File metadata and controls

53 lines (34 loc) · 2.97 KB

Contributing to BPL

Thank you for your interest in contributing to BPL, the Blender Python Library Wrapper! We appreciate contributions from everyone, whether it's in the form of code, documentation, bug reports, or feature requests. This document outlines how you can contribute to the BPL project.

Getting Started

Before you begin, please ensure you have a GitHub account and are familiar with GitHub workflows. Additionally, you should have a basic understanding of Python programming and, ideally, some experience with Blender's Python API (bpy).

How to Contribute

Reporting Bugs

If you encounter a bug in BPL, please open an issue on our GitHub repository. Include the following information to help us understand and reproduce the issue:

  • A clear and concise description of the bug.
  • Steps to reproduce the bug.
  • The expected behavior.
  • Any error messages or screenshots.
  • Your environment information, such as Blender version and operating system.

Suggesting Enhancements

We welcome suggestions for enhancements or new features. Please open an issue to describe your suggestion, providing as much detail and context as possible. Explain why you believe this enhancement would be beneficial to BPL users.

Your First Code Contribution

Ready to contribute code? Great! Here's how to get started:

  1. Fork the Repository: Navigate to the BPL GitHub repository and click the "Fork" button to create your own copy of the project.
  2. Clone Your Fork: Clone your forked repository to your local machine using git clone.
  3. Create a Branch: Create a new branch for your contribution using git checkout -b feature/YourFeatureName.
  4. Make Your Changes: Implement your feature or fix, adhering to the existing coding style as much as possible.
  5. Test Your Changes: Ensure your changes do not introduce any new bugs and that all existing tests pass.
  6. Commit Your Changes: Commit your changes using a clear and descriptive commit message.
  7. Push to Your Fork: Push your changes to your forked repository on GitHub.
  8. Submit a Pull Request: Open a pull request against the original BPL repository. Provide a clear description of your changes and any other relevant information.

Pull Request Guidelines

  • Ensure your code is well-documented and follows PEP 8 style guidelines for Python code.
  • Include any necessary tests for your changes.
  • Update the README.md or documentation if your changes introduce new features or significant changes to existing functionality.
  • Keep your pull requests focused on a single issue or feature to facilitate easier review.

Code of Conduct

This project adheres to a Code of Conduct. By participating in this project, you agree to abide by its terms.

Questions or Assistance

If you have any questions or need assistance with contributing to BPL, please feel free to reach out to the project maintainers or open an issue for general questions.

Thank you for contributing to BPL, and we look forward to your contributions!