Skip to content

Latest commit

 

History

History
63 lines (47 loc) · 2.42 KB

CONTRIBUTING.md

File metadata and controls

63 lines (47 loc) · 2.42 KB

Contributing to Pokémon Battle Simulator

First off, thank you for taking the time to contribute! 🎉

The following is a set of guidelines for contributing to Pokémon Battle Simulator. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

How to Contribute

Reporting Bugs

If you find a bug, please create an issue in the repository. Include as much detail as possible, including:

  • Steps to reproduce the bug.
  • The expected behavior.
  • The actual behavior.
  • Screenshots or logs, if applicable.
  • Your environment (OS, Python version, etc.).

Suggesting Enhancements

If you have an idea for a new feature or an enhancement to an existing feature, please open an issue and describe your suggestion. Include:

  • A detailed description of the proposed enhancement.
  • The motivation for the enhancement.
  • Any benefits or potential drawbacks.
  • Any related issues or pull requests.

Submitting Pull Requests

  1. Fork the repository: Create a fork of this repository by clicking on the "Fork" button.
  2. Clone your fork: Clone your fork to your local machine. 
    git clone https://github.com/your-username/pokemon-battle-simulator.git
  3. Create a branch: Create a new branch for your work. 
    git checkout -b my-feature-branch
  4. Make your changes: Implement your changes in the new branch.
  5. Commit your changes: Write clear, concise commit messages. 
    git commit -m "Add feature X"
  6. Push to your fork: Push your changes to your fork. 
    git push origin my-feature-branch
  7. Create a pull request: Open a pull request from your branch to the main repository's main branch.

Code Style

Please follow these guidelines to keep the codebase consistent:

  • Use PEP 8 as the style guide for Python code.
  • Write meaningful commit messages.
  • Comment your code where necessary to explain complex logic.

Code of Conduct

Please adhere to the project's Code of Conduct. We expect everyone to follow these guidelines to ensure a welcoming and inclusive environment for all contributors.

Getting Help

If you have any questions or need further guidance, feel free to reach out by opening an issue or contacting the project maintainers.

Thank you for your contributions! Let's make Pokémon Battle Simulator better together! 💪🏻