Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
35 lines (23 loc) · 1.15 KB

CONTRIBUTING.md

File metadata and controls

35 lines (23 loc) · 1.15 KB
Raw

Contributing to ShineButton

Thank you for your interest in contributing to ShineButton! We welcome all contributions, including bug fixes, new features, and documentation improvements.

How to Contribute

Reporting Bugs

  • Search the issue tracker for existing reports.
  • If no issue exists, create a new one with a clear description and steps to reproduce.

Suggesting Features

  • Open an issue to discuss your proposed feature before starting any work.

Submitting Pull Requests

  1. Fork the repository.
  2. Create a new branch for your changes: git checkout -b feature/my-new-feature.
  3. Make your changes and ensure they follow the project's coding style.
  4. Add or update tests as needed.
  5. Commit your changes: git commit -am 'Add some feature'.
  6. Push to the branch: git push origin feature/my-new-feature.
  7. Submit a pull request.

Coding Standards

  • Follow standard Android coding conventions.
  • Use meaningful variable and method names.
  • Keep methods short and focused.
  • Add comments where necessary, but aim for self-documenting code.

License

By contributing, you agree that your contributions will be licensed under the MIT License.