Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
42 lines (27 loc) · 2.72 KB

CONTRIBUTING.md

File metadata and controls

42 lines (27 loc) · 2.72 KB
Raw

Contributing to BTXS™

First off, thank you for considering contributing to BTXS! Your help is invaluable in making this project better. This document provides guidelines to ensure a smooth and effective contribution process.

How Can I Contribute?

Reporting Bugs

  • Ensure the bug was not already reported by searching on GitHub under Issues.
  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to use the "Bug Report" template and include as much detail as possible.

Suggesting Enhancements

  • We are always looking for ideas to improve BTXS!
  • Please check the Issues to see if your idea has already been discussed.
  • If not, open a new issue using the "Feature Request" template.

Pull Requests

We welcome pull requests for bug fixes and feature enhancements. Please follow these steps to have your contribution considered:

  1. Fork the repository to your own GitHub account.
  2. Clone your fork to your local machine: git clone https://github.com/BlackTechX011/BTXS.git
  3. Create a new branch for your changes: git checkout -b feature/my-amazing-feature or fix/a-specific-bug.
  4. Make your changes. Ensure you adhere to the project's coding style by running go fmt ./... and goimports -w . within the BTXS/ directory.
  5. Update Documentation. If you add or change a command or flag, please update the relevant help text in main.go and, if necessary, the README.md.
  6. Commit your changes with a clear and descriptive commit message.
  7. Push your branch to your fork: git push origin feature/my-amazing-feature.
  8. Open a Pull Request to the main branch of the BlackTechX011/BTXS repository. Provide a clear title and description for your changes.

Contributor License Agreement

BTXS is distributed under a custom End-User License Agreement (EULA), not a standard open-source license. Please review the LICENSE.md file carefully.

By submitting a pull request, you certify that:

  • (a) You have the right to submit the contribution, and it does not violate any third-party rights.
  • (b) You agree that your contribution will be licensed under the same terms as the existing BTXS EULA.
  • (c) You understand and agree that your contribution is subject to the same restrictions, including the prohibition on commercial use without permission and the naming requirements for derivative works.

This ensures that the project remains consistent and legally sound. We appreciate your understanding and cooperation.