Skip to content
This repository has been archived by the owner on Sep 10, 2024. It is now read-only.

Latest commit

 

History

History
69 lines (43 loc) · 3.09 KB

CONTRIBUTING.md

File metadata and controls

69 lines (43 loc) · 3.09 KB

Contributing to DeathGarden_API_Rebirth

EOL NOTICE

This Project has stoped development and is no longer maintained.

DO NOT CONTRIBUTE TO THIS PROJECT ANYMORE!

OLD CONTRIBUTING.MD BELOW

Thank you for considering contributing to DeathGarden_API_Rebirth! This Flask API is designed for the game Deathgarden Bloodharvest, and we welcome any additions, bug fixes, improvements, or other contributions from the community.

We believe that collaboration is essential to building a successful project, and we value every contribution made by individuals like you. To ensure a smooth and effective collaboration, please take a moment to read and follow the guidelines outlined in this document.

Getting Started

Before you start contributing, make sure you have the following prerequisites:

  • Python (3.9 or higher)
  • Flask (latest)
  • Any additional dependencies specified in the project's requirements.txt

How to Contribute

  1. Fork the repository: Fork the DeathGarden_API_Rebirth repository to your GitHub account and clone it to your local machine.

  2. Create a Branch: For every contribution you make, create a new branch from the main branch with a descriptive name. This will help us in identifying the purpose of your changes.

  3. Code and Test: Make your desired changes to the codebase and ensure it meets the project's standards. Write unit tests to verify your changes where applicable.

  4. Documentation: If you are introducing new features, make sure to update the project's documentation in the doc directory. If you make changes to existing features, ensure the documentation is updated accordingly.

  5. Commit Changes: Commit your changes with a clear and concise commit message that describes the purpose of your contribution.

  6. Pull Request: Push your branch to your forked repository and create a Pull Request (PR) to the main branch of the main repository. Provide a detailed description of your changes in the PR, along with any relevant information or context.

  7. Code Review: Your PR will be reviewed by maintainers and contributors. Be prepared to make necessary adjustments based on the feedback received.

  8. Merge: Once your PR has been approved, it will be merged into the main repository. Congratulations on your successful contribution!

Coding Guidelines

  • Follow the PEP 8 style guide for Python code.
  • Write clear and descriptive variable and function names.
  • Comment your code where necessary, especially for complex logic. (Please name functions logical and variabels so comments are not needed.)
  • Ensure your code is well-formatted and easy to read.

Reporting Issues

If you encounter any bugs, have questions, or want to suggest improvements, feel free to open an issue on the repository. Please provide detailed information about the problem you encountered or the suggestion you have in mind.

We appreciate your interest in contributing to DeathGarden_API_Rebirth, and we look forward to your valuable contributions to the project! If you have any further questions, feel free to reach out to us.

Happy coding!