stevedunn / pacmanblazor

Contributing to pacmanblazor

This guide outlines the process for contributing to the pacmanblazor project.

Getting Started

  1. Fork the Repository: Create a fork of the pacmanblazor repository on GitHub. https://github.com/stevedunn/pacmanblazor
  2. Clone your Fork: Clone your forked repository to your local machine.
git clone [email protected]:<your-github-username>/pacmanblazor.git
  1. Create a Branch: Create a new branch for your contribution.
git checkout -b <your-feature-branch-name>
  1. Install Dependencies: Install the project’s dependencies using the following command:
dotnet restore

Making Changes

  • Identify an Issue: Choose an issue you’d like to address from the project’s issue tracker.
  • Develop Your Solution: Implement your solution in your chosen branch, ensuring it adheres to the existing project structure and coding conventions.
  • Write Tests: Write unit tests to ensure your code works as expected.
  • Document Changes: Update the documentation for any changes you make.

Submitting Your Contribution

  1. Commit Your Changes: Commit your changes to your branch.
git add .
git commit -m "Fix: <brief description of your change>"
  1. Push Your Branch: Push your branch to your forked repository.
git push origin <your-feature-branch-name>
  1. Create a Pull Request: Create a pull request from your branch to the main repository. Provide a clear and concise description of your changes and the issue you’re addressing.

Building and Testing the Project

  • Build: Use the following command to build the application.
dotnet build
  • Run: Use the following command to run the application.
dotnet run
  • Test: Use the following command to run the unit tests for the application.
dotnet test
  • Clean: Use the following command to clean the output of previous builds.
dotnet clean

Code Style and Conventions

  • Follow the existing code style and conventions used in the project.
  • Use descriptive variable and function names.
  • Adhere to best practices for writing maintainable and readable code.
  • Note: The project does not have a code style guide. Refer to the existing code for guidance.

Communication

  • Engage with the project maintainers and other contributors through the issue tracker and pull requests.
  • Be respectful and professional in your communication.

Project Contributions

  • The pacmanblazor project welcomes contributions of all kinds, including:
  • Bug fixes
  • New features
  • Documentation improvements
  • Code refactoring
  • Testing improvements

Additional Information

  • Review the project’s README.md file for more detailed information on the project and its functionality.
  • Use the issue tracker to report any bugs or request new features.

Closing Note

Thank you for considering contributing to pacmanblazor. Your contributions help to improve the project and make it better for everyone.