stevedunn / pacman-typescript

Contributing to stevedunn/pacman-typescript

This document provides guidance on contributing to the stevedunn/pacman-typescript project.

Getting Started

  1. Fork the Repository: Create a copy of the project by forking the repository on GitHub.
  2. Clone Your Fork: Clone your forked repository to your local machine:
git clone https://github.com/<your-username>/pacman-typescript.git
  1. Install Dependencies: Install the necessary dependencies for the project using npm:
cd pacman-typescript
npm install

Making Changes

  1. Create a Branch: Create a new branch for your changes:
git checkout -b feature/your-change-description

  1. Make Your Changes: Implement your changes, focusing on a single feature or bug fix per branch.

  2. Test Your Changes: Ensure your changes work as intended.

  • The current project doesn’t have defined tests, so focus on manual testing.
  • If adding new features, consider writing unit tests or integration tests to ensure long-term quality.
  1. Commit Your Changes: Commit your changes with a clear and descriptive message:
git add .
git commit -m "feat: Implement your feature"
  1. Push to Your Fork: Push your branch to your forked repository:
git push origin feature/your-change-description

Submitting a Pull Request

  1. Create a Pull Request: Navigate to your forked repository on GitHub and create a pull request from your branch to the main branch of the original stevedunn/pacman-typescript repository.

  2. Provide a Clear Description: Include a detailed description of your changes, including:

  • The problem you’re solving
  • The solution you’ve implemented
  • Any relevant notes or considerations

  1. Address Feedback: The project maintainer may provide feedback or request changes. Respond to their comments promptly and make any necessary adjustments.

  2. Wait for Approval: Once your changes are reviewed and approved, they will be merged into the main branch of the repository.

Additional Notes

  • The project does not yet have a formal contribution guide. It’s encouraged to review existing code and align with the project’s style and conventions.
  • If you’re unsure about any aspect of the project, feel free to open an issue or reach out to the project maintainer directly on GitHub.

By following these guidelines, you can contribute to the improvement of stevedunn/pacman-typescript and collaborate with other developers.