Skip to content

Latest commit

 

History

History
49 lines (25 loc) · 2.93 KB

CONTRIBUTING.md

File metadata and controls

49 lines (25 loc) · 2.93 KB

Contributing to the Game Discovery Platform

We appreciate your interest in contributing to the Game Discovery Platform! Your contributions can help enhance the platform and make it even better for the gaming community. Before you get started, please take a moment to review the following guidelines.

Code of Conduct

Please note that we have a Code of Conduct in place to ensure a positive and inclusive environment for all contributors. By participating in this project, you are expected to adhere to the Code of Conduct. Violations will not be tolerated, and appropriate actions will be taken. You can find our Code of Conduct here.

How to Contribute

Contributing to the Game Discovery Platform is easy! Just follow these steps:

  1. Fork the Repository: Click the "Fork" button on the top right corner of the repository to create your copy.

  2. Set Up the Development Environment: Follow the instructions in the README.md file to set up the project locally on your machine.

  3. Create a Branch: Before making any changes, create a new branch with a descriptive name. For example, feature/new-feature or fix/bug-fix.

  4. Make Changes: Implement your changes or additions to the project.

  5. Testing: Ensure that your changes are well-tested, and the application works as expected.

  6. Commit: Commit your changes with clear and descriptive commit messages.

  7. Push: Push your changes to the branch on your forked repository.

  8. Create a Pull Request: Open a pull request (PR) to the main branch of the original repository. In your PR, describe the changes you made, why they are valuable, and any relevant information for reviewers.

Guidelines

To ensure a smooth review process and increase the likelihood of your contributions being accepted, please follow these guidelines:

  • Follow Coding Standards: Maintain the existing coding style, indentation, and naming conventions used in the project.

  • One Feature per Pull Request: If you're working on multiple features or fixes, create separate pull requests for each, as it simplifies the review process.

  • Write Tests: Whenever possible, include test cases for your changes to ensure they function as expected.

  • Documentation: Update the relevant documentation if your changes affect the application's behavior or add new features.

  • Be Responsive: Be responsive to any feedback or questions related to your pull request. It helps speed up the merging process.

  • Be Respectful: Respect the opinions and efforts of others. Be open to feedback and be constructive in your interactions.

Getting Help

If you have any questions or need assistance with anything related to the project, feel free to open an issue in the repository. We are here to help and ensure a smooth contributing experience for everyone.

Thank you for your interest in contributing to the Game Discovery Platform! We look forward to your valuable contributions and hope you enjoy being part of our community. Happy gaming! 🎮