Skip to content

Latest commit

 

History

History
75 lines (48 loc) · 2.01 KB

CONTRIBUTING.md

File metadata and controls

75 lines (48 loc) · 2.01 KB
Raw

Contributing to Zarban SDK

We appreciate your interest in contributing to the Zarban SDK! Contributions are key to improving our project, and we welcome bug reports, feature requests, and pull requests.

How to Contribute

1. Fork the Repository

2. Clone Your Fork

git clone https://github.com/your-username/zarban-py.git
cd zarban-py

3. Create a New Branch

Use a descriptive branch name, e.g., feature/feature-name or fix/issue-description.

git checkout -b feature/your-feature

4. Make Your Changes

Ensure that your code is well-documented. Follow the project's code style and structure.

5. Run Tests

Run the tests to make sure everything works as expected.

6. Commit Your Changes

Add a meaningful commit message. Refer to issues by their number if applicable (e.g., #123).

git commit -m "Add feature: detailed feature description"

7. Push Your Changes

git push origin feature/your-feature

8. Open a Pull Request

  • Go to the original repository on GitHub.
  • Click on New Pull Request.
  • Select the branch you just pushed from the dropdown menu.
  • Add a descriptive title and summary of your changes.
  • Reference any relevant issues (e.g., #123).

markdown

Reporting Bugs

If you encounter a bug, please help us improve the Zarban SDK by reporting it.

  • Search Existing Issues: Before submitting, check the GitHub Issues to see if the problem has already been reported.
  • Open a New Issue: If the issue is not reported, open a new issue and provide the following details:
    • A clear description of the bug.
    • Steps to reproduce the issue.
    • Expected and actual behavior.
    • Relevant error messages or screenshots, if applicable.
    • Version of Zarban SDK you are using.

Code Style

Please ensure your code adheres to PEP 8 and includes type hints where possible.

Thank you for your contribution!