Skip to content

Latest commit

 

History

History
53 lines (27 loc) · 2.75 KB

CONTRIBUTING.md

File metadata and controls

53 lines (27 loc) · 2.75 KB
Raw

Contributing to Trainer App

Thank you for your interest in contributing to Trainer App! We welcome contributions from anyone, and appreciate all forms of help, whether it's reporting issues, suggesting improvements, or submitting pull requests.

Getting Started

Before you start contributing, please make sure that you have read and agree to our code of conduct. We want all contributors to feel welcome and safe in our community.

If you've never contributed to an open source project before, you might find it helpful to read GitHub's guide to contributing to open source.

Ways to Contribute

There are many ways to contribute to Trainer App. Here are a few examples:

  • Reporting issues: If you encounter a bug or issue while using Trainer App, please report it by opening a GitHub issue in our repository. Please include as much information as possible to help us reproduce the issue.

  • Suggesting improvements: If you have an idea for how to improve Trainer App, please let us know by opening a GitHub issue. We welcome suggestions for new features, enhancements to existing features, or improvements to our documentation.

  • Submitting pull requests: If you want to contribute code to Trainer App, please submit a pull request. Before you start coding, please make sure that there is an open issue for the bug or feature you are working on, or open a new issue to discuss your proposed change.

How to Contribute

Here are the general steps for contributing code to Trainer App:

  1. Fork the Trainer App repository to your own GitHub account.

  2. Clone the forked repository to your local machine.

  3. Create a new branch for your changes.

  4. Make your changes and commit them with a clear and descriptive message.

  5. Push your changes to your forked repository.

  6. Submit a pull request to the Trainer App repository, explaining the changes you made and why they are important.

  7. Wait for feedback and approval from the project maintainers. Please be patient - we're a small team and it may take us some time to review your changes.

Code Style and Guidelines

Please follow these guidelines when contributing code to Trainer App:

  • Code should be well-documented and easy to read.

  • Code should be written in Python, following the PEP8 style guide.

  • Pull requests should include unit tests for any new code, and should not break any existing tests.

Conclusion

We appreciate your interest in contributing to Trainer App, and we look forward to your contributions. If you have any questions or need help getting started, please don't hesitate to reach out to us by opening a GitHub issue or contacting the project maintainers directly.

Thank you for helping make Trainer App a better project!