Skip to content

Latest commit

 

History

History
59 lines (35 loc) · 2.19 KB

CONTRIBUTING.md

File metadata and controls

59 lines (35 loc) · 2.19 KB
Raw

Contributing to Chip-8 Emulator

Thank you for your interest in contributing to the Chip-8 Emulator project! We welcome contributions from the community and appreciate any improvements or bug fixes you can provide. Please follow the guidelines below to help us maintain the quality and consistency of the project.

How to Contribute

  1. Fork the Repository

    Start by forking the repository on GitHub. This will create a personal copy of the project where you can make changes.

    git clone https://github.com/wojlin/js-chip8

  2. Create a Branch

    Create a new branch for your changes. Use a descriptive name for the branch related to the feature or fix you are working on.

    git checkout -b feature/my-new-feature

  3. Make Changes

    Implement your changes, ensuring that they adhere to the project's coding style and guidelines. Run the code through any existing linting or testing tools to make sure everything works correctly.

  4. Commit Your Changes

    Commit your changes with a descriptive commit message. Ensure your commits are well-organized and focused on a single topic.

    git add .
git commit -m "Add feature X to improve Y"

  5. Push Your Changes

    Push your changes to your forked repository on GitHub.

    git push origin feature/my-new-feature

  6. Create a Pull Request

    Navigate to the original repository on GitHub and create a pull request from your branch. Provide a clear description of the changes you’ve made and why they should be merged.

Guidelines

  • Code Style: Follow the existing code style and formatting in the project. Consistency is key for readability and maintainability.
  • Documentation: Update documentation as needed to reflect any changes or new features.
  • Testing: Ensure that your changes are well-tested. If possible, add new tests to cover the changes.

Code of Conduct

Please be respectful and professional in all interactions related to the project. Our community is dedicated to creating a welcoming and inclusive environment for everyone.

Thank you for contributing to the Chip-8 Emulator project! Your help makes this project better for everyone.