Skip to content

Latest commit

 

History

History
94 lines (58 loc) · 2.63 KB

CONTRIBUTING.md

File metadata and controls

94 lines (58 loc) · 2.63 KB
Raw

Contribution Guidelines

Thank you for your interest in contributing to our game! We welcome contributions from the community to help make the game even better. Please take a moment to review the guidelines below before getting started.

Getting Started

To contribute to the game, you'll need to have the following installed on your machine:

Setting Up the Development Environment

  1. Clone the repository:

    git clone https://github.com/geraldohomero/worst-game-ever.git

  2. Install the dependencies:

    cd worst-game-ever
npm install

  3. Set up the MySQL database:

    • Create a new MySQL database.
    • Update the database configuration in config.js with your MySQL credentials.

  4. Start the development server:

    npm run dev

Contributing

We use the following branching strategy:

  • main branch: Represents the latest stable release.
  • develop branch: Represents the latest development version

Still to be created.

To contribute to the game, follow these steps:

  1. Create a new branch from the develop branch:

    git checkout develop
git checkout -b feature/your-feature-name

  2. Make your changes and commit them:

    git add .
git commit -m "Add your commit message here"

  3. Push your branch to the remote repository:

    git push origin feature/your-feature-name

  4. Open a pull request on GitHub and provide a detailed description of your changes.

Code Style

We follow the JavaScript Standard Style for our codebase. Please make sure your code adheres to this style.

Testing

We will have a suite of automated tests in place to ensure the stability of the game. Before submitting a pull request, please make sure that your code passes all tests.

License

By contributing to the game, you agree that your contributions will be licensed under its GPL-3.0 license.

Code of Conduct

We expect all contributors to abide by our Code of Conduct.

Questions

If you have any questions, please open an issue on GitHub and we will get back to you as soon as possible.

Acknowledgements