Skip to content

Latest commit

 

History

History
85 lines (58 loc) · 3.36 KB

CONTRIBUTING.md

File metadata and controls

85 lines (58 loc) · 3.36 KB

Contributing to Prisoner's Dilemma Game

Thank you for considering contributing to the Prisoner's Dilemma Game! We appreciate your time and effort in making this project better. Please read the following guidelines to understand how you can contribute effectively.

How Can You Contribute?

1. Reporting Bugs

If you encounter any bugs or issues while using the game, please report them by creating an issue on GitHub. When reporting a bug, please include:

  • A clear and descriptive title.
  • Steps to reproduce the issue.
  • The expected and actual results.
  • Screenshots or terminal output, if possible.
  • The operating system and Go version you are using.

2. Suggesting Enhancements

If you have ideas to improve the game, whether it’s new features, better code structure, or UI enhancements, we’d love to hear them! You can submit your suggestions by opening a new issue and selecting the "Feature Request" template.

3. Submitting Pull Requests

Steps to Submit a Pull Request:

  1. Fork the repository:

    • Go to the project repository and click the "Fork" button in the upper right corner.

  2. Clone your fork:

    git clone https://github.com/kh3rld/prisoners-dilemma.git
cd prisoners-dilemma

  3. Create a new branch:

    • It's important to create a new branch for each feature or bugfix you work on.
    git checkout -b feature/your-feature-name

  4. Make your changes:

    • Implement your changes, whether it’s fixing a bug, adding a feature, or improving documentation.
    • Ensure your code follows the project’s coding style and is properly documented.

  5. Test your changes:

    • Run existing tests to ensure your changes don’t break anything.
    • Add new tests if your changes add or modify functionality.

  6. Commit your changes:

    git add .
git commit -m "Description of your changes"

  7. Push to your fork:

    git push origin feature/your-feature-name

  8. Submit a pull request:

    • Go to the original repository, and you’ll see a "Compare & pull request" button for your branch.
    • Provide a descriptive title and a detailed description of your changes.
    • Reference any related issues (e.g., "Closes #123").

Code Style Guidelines

  • Follow Go's standard formatting guidelines. You can use gofmt to format your code.
  • Write clear and concise comments where necessary.
  • Keep functions and methods small and focused.

4. Improving Documentation

  • Help us keep the documentation up to date! If you find any discrepancies or have suggestions for better clarity, feel free to submit a pull request.
  • Consider adding examples, diagrams, or tutorials that could help others understand the project better.

Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct. We are committed to providing a welcoming and respectful environment for all contributors.

License

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

Getting Help

If you have any questions or need further assistance, feel free to open an issue or contact us via X or email.