Skip to content

Latest commit

 

History

History
61 lines (38 loc) · 2.33 KB

CONTRIBUTING.md

File metadata and controls

61 lines (38 loc) · 2.33 KB

Contribution Guidelines

Thank you for considering contributing to our project! We welcome contributions from the community and are grateful for your support.

How to Contribute

Reporting Bugs

If you find a bug, please report it by creating an issue on GitHub. Please include as much detail as possible to help us understand and reproduce the issue.

Suggesting Enhancements

If you have an idea for an enhancement or new feature, please open an issue on GitHub and describe your suggestion in detail.

Submitting Pull Requests

  1. Fork the Repository: Click the "Fork" button at the top right of the repository page to create a copy of the repository on your GitHub account.

  2. Clone Your Fork: Clone your forked repository to your local machine.

    git clone https://github.com/<yourname>/R6StatAPI.git
cd your-project

  3. Create a Branch: Create a new branch for your work.

    git checkout -b feature/your-feature-name

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

  5. Commit Changes: Commit your changes with a descriptive commit message.

    git add .
git commit -m "Add feature: your feature description"

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

    git push origin feature/your-feature-name

  7. Create a Pull Request: Go to the original repository and create a pull request from your forked repository. Please provide a clear and descriptive title and description for your pull request.

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, feel free to ask for clarification by opening an issue.

Testing

Please ensure that your changes do not break any existing tests and add new tests for any new functionality. Run the tests locally before submitting your pull request.

License

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

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 for your contributions!