Skip to content

Latest commit

 

History

History
63 lines (39 loc) · 1.62 KB

CONTRIBUTING.md

File metadata and controls

63 lines (39 loc) · 1.62 KB

Contributing to Pong Game

Thank you for considering contributing to the Pong Game! We appreciate your time and effort in making this project better. Please take a moment to review the following guidelines before getting started.

Getting Started

  1. Fork the repository and clone it locally.

    git clone https://github.com/Ramzi-Abidi/Pong

  2. Create a new branch for your feature or bug fix.

    git checkout -b feature/your-feature

  3. Install the required dependencies.

    npm install

  4. Make your changes and test thoroughly.

  5. Commit your changes with a clear and concise commit message.

    git commit -m "Add feature/fix: Description of your changes"

  6. Push your branch to your fork.

    git push origin feature/your-feature

  7. Before creating a pull request, rebase with main branch to avoid conflicts.

  8. Create a pull request against the main branch of the main repository.

  9. Add description and screenshots to your pull request.

Code Style

  • Use "prettier" extension to style your code.
  • Use clear and descriptive variable and function names.
  • Write meaningful comments to explain complex parts of the code.

Documentation

  • Update the documentation if your changes impact how the game is played or any setup instructions.

Issues and Discussions

  • Feel free to open an issue for bug reports or feature requests.
  • Participate in discussions on existing issues.

Feedback

  • If you enjoyed playing or contributing to the game, don't forget to star the repo.

  • Thanks for your contribution! 🚀