Skip to content

Latest commit

 

History

History
84 lines (65 loc) · 4.68 KB

CONTRIBUTING.md

File metadata and controls

84 lines (65 loc) · 4.68 KB
Raw

Contributing to TFT Guide

Thank you for your interest in contributing to TFT Guide! We welcome community contributions to help improve the app.

General Guidelines

  1. Read the code of conduct
    • Familiarize yourself with our expectations for community behavior.
  2. Search existing discussions:
    • Before creating a new discussion, check for existing conversations to avoid duplicates and keep our discussions focused.
  3. Be respectful and constructive:
    • Maintain a positive and respectful tone in all communications. Constructive feedback is essential for a healthy community.
  4. Use the appropriate template:
    • When submitting a reporting a bug, request for help, suggesting an idea, or creating a pull request, ensure you use the relevant template to provide all necessary information.

Creating a Pull Request

Before creating a pull request, please follow these steps:

  1. Fork the repository: Create your own fork and clone it to your local machine.
  2. Create your branch: Start your new branch from `main (e.g., git checkout -b feature/your-feature).
  3. Install dependencies: Ensure all dependencies are installed and up to date.
  4. Squash your commits: Combine your commits into a single, meaningful commit message.
  5. Add tests: If you’ve fixed a bug or added new functionality, please include tests.
  6. Run tests: Ensure the test suite passes before submitting your PR.
  7. Format and analyze your code: Use tools like make style to format your code and check for issues.
  8. Create the pull request: Submit your PR and include a detailed description of the changes made.
  9. Verify status checks: Ensure all status checks are passing before finalizing your PR.

Report a bug

When reporting a bug, please use the provided template to ensure that all necessary information is included. This template is designed to guide you through providing the details needed to understand and address the issue effectively.

  • App version: Specify the version of the app where you encountered the bug. This helps us understand if the issue is version-specific.
  • Device information: Provide details about the device you are using, such as the model and operating system. This information is crucial for reproducing hardware-specific or OS-specific bugs.
  • Description: Give a clear and detailed description of the bug. The more specific you are, the easier it will be for us to understand the issue.
  • Steps to reproduce: List the steps you took when you encountered the bug. This should be a clear, step-by-step process to help us replicate the issue.
  • Expected behavior: Describe what you expected to happen when you followed the steps above. This helps clarify the discrepancy between expected and actual behavior.
  • Screenshots: If possible, include links to screenshots or images that illustrate the issue. Visual evidence can be very helpful in quickly identifying problems.
  • Additional information: Provide any other context or information that might be relevant. This could include error logs, console output, or conditions under which the bug does not occur.

Requesting help

When requesting help, please use the provided template to ensure that all necessary information is included. This template is designed to guide you in explaining your question clearly and effectively.

  • Detail your question: Describe your issue in detail, explaining what you are trying to achieve and where you are stuck.
  • Include code snippets: If relevant, provide code snippets to give context.

Suggest an idea

When suggesting an idea, please use the provided template to ensure that all necessary information is included. This template is designed to guide you in articulating your suggestion clearly and effectively.

  • Clearly articulate your idea: Provide a clear and concise description of your suggestion, including how it would improve the app.
  • Explain use cases: Share specific scenarios where your idea would be useful.
  • Be open to feedback: Encourage discussion and be willing to refine your idea.

By following these guidelines and utilizing the provided templates, you contribute to a more organized and efficient process for our community. Your insights and contributions are invaluable in helping us improve the app and create a better experience for all users. Thank you for your support and dedication!

License

By contributing to TFT Guide, you agree that your contributions will be licensed under the BSD-3-Clause License.