Stefan's Boardgames Apps

Various boardgame solo apps and companions.

Apps and Packages

• ironwood: a Ironwood solo AI automa app
• botc: a Blood on the Clocktower script tool hosted at https://botcscript.app - upload, modify, translate, and print player script sheets and first/other night order sheets
• @repo/decker: Cards management tool

---

Contribution Guidelines

We welcome contributions to this project and are excited to collaborate with developers and open-source enthusiasts. This document provides some basic rules to guide you through the process of contributing. By contributing to this project, you agree to follow these guidelines and abide by our code of conduct.

1. Getting Started

• Fork the repository: Start by forking the project to your own GitHub account.
• Clone your fork: After forking, clone the repository to your local machine:

  git clone https://github.com/stefanbackor/boardgames.git
  

• Set up the project: Follow the instructions in the README.md to set up the project locally.

2. Reporting Issues

• Before opening a new issue, please search through existing issues to avoid duplicates.
• If reporting a bug, ensure your issue includes:
  • A clear, descriptive title.
  • Steps to reproduce the problem.
  • Expected behavior versus actual behavior.
  • Relevant logs, error messages, or screenshots.
• If requesting a feature, explain why it’s beneficial and how it can be used.
• Don't forget to label the issue with game title.

3. Making Changes

• Create a new branch: Create a branch for your feature or bugfix:

  git checkout -b feature/your-feature-name
  

• Write clear commit messages: Each commit should be well-documented. Follow this format:

  Add concise description of your change (issue #123)
  
  - List changes made.
  - Explain the purpose of the change.
  

• Follow code style guidelines: Adhere to the coding standards and style guides used in the project which are enforced by CI.

4. Testing

• Write tests for any new features or changes.
• Ensure that all tests pass before submitting your contribution:

  yarn test
  

5. Pull Requests

• Open a Pull Request (PR): Once you're ready, push your branch and create a pull request from your fork to the main project repository.
• Provide a clear PR description: Include a summary of what changes were made, why they were made, and how they solve the issue or improve the project.
• Follow the template: Use the PR template provided by the repository, if applicable.
• Be patient and responsive: The maintainers will review your code, so be prepared to make changes based on feedback.
• Reference related issues: If your PR addresses an issue, be sure to reference it by number (e.g., Fixes #123).

6. Code of Conduct

By participating in this project, you agree to follow our Code of Conduct. This ensures that all community members interact in a respectful, collaborative, and constructive manner.

7. Licensing

• By submitting a contribution, you agree that your code will be licensed under the MIT License, as per the project’s existing license.
• Make sure your contributions do not violate any licenses or intellectual property rights.

Thank you for contributing! We look forward to building this project together.

---