Thank you for your interest in contributing to BTXZ. This document outlines the standards and procedures for submitting code, reporting issues, and proposing enhancements.
All contributors are expected to maintain a professional and respectful demeanor. Harassment or abusive behavior will not be tolerated.
When submitting a bug report, please ensure the following information is included to facilitate rapid diagnosis:
- System Information: Operating System, Architecture (amd64/arm64), and BTXZ version.
- Reproduction Steps: A concise, step-by-step guide to reproducing the issue.
- Expected Behavior: What you anticipated would happen.
- Actual Behavior: What actually happened, including full error logs and stack traces if available.
Feature proposals should include:
- Use Case: A clear explanation of the problem this feature solves.
- Proposed Implementation: A high-level technical overview of how the feature could be implemented.
- Alternatives: Other solutions that were considered.
- Fork and Clone: Fork the repository and clone it locally.
- Branching: Create a feature branch (
feature/description) or a fix branch (fix/issue-description). - Coding Standards:
- Adhere to standard Go idioms and formatting.
- Run
go fmt ./...before committing. - Ensure all new code is covered by tests where applicable.
- Commit Messages: Use imperative mood (e.g., "Add support for X", not "Added support for X").
- Submission: Open a Pull Request against the
mainbranch. Provide a detailed description of the changes.
By submitting a contribution, you agree that your code will be licensed under the terms of the project's LICENSE. You certify that you have the right to submit the code and that it does not infringe upon any third-party intellectual property rights.
Do not report security vulnerabilities via public GitHub issues. Please disclose them responsibly by contacting the maintainers directly.