Skip to content

Latest commit

 

History

History
69 lines (41 loc) · 2.38 KB

CONTRIBUTING.md

File metadata and controls

69 lines (41 loc) · 2.38 KB

Contributing to RunnerPost

Thank you for considering contributing to RunnerPost! We welcome contributions from everyone. By participating in this project, you agree to abide by our code of conduct.

How to Contribute

Reporting Bugs

If you find a bug, please report it by opening an issue on our GitHub Issues page. Please include as much detail as possible, including steps to reproduce the issue, your environment, and any relevant logs or screenshots.

Suggesting Features

We welcome suggestions for new features! Please open an issue on our GitHub Issues page and describe the feature you would like to see, why you need it, and how it should work.

Submitting Changes

  1. Fork the repository: Click the "Fork" button at the top right of the repository page.

  2. Clone your fork: Clone your forked repository to your local machine.

    git clone https://github.com/your-username/RunnerPost.git
cd RunnerPost

  3. Create a branch: Create a new branch for your changes.

    git checkout -b feature/your-feature-name

  4. Make your changes: Make your changes to the codebase.

  5. Commit your changes: Commit your changes with a clear and descriptive commit message.

    git commit -am 'Add new feature'

  6. Push your changes: Push your changes to your forked repository.

    git push origin feature/your-feature-name

  7. Open a Pull Request: Go to the original repository and open a pull request. Describe your changes and link to any relevant issues.

Code Style

Please follow the existing code style and conventions used in the project. If you are unsure about any aspect of the code style, please ask for clarification in your pull request.

Running Tests

Before submitting your changes, please ensure that all tests pass. You can run the tests using the following command:

pytest

Documentation

If your changes affect the public API or user-facing features, please update the documentation accordingly.

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project, you agree to abide by its terms.

Thank You!

Thank you for your interest in contributing to RunnerPost! Your contributions are greatly appreciated.