Skip to content

Latest commit

 

History

History
65 lines (52 loc) · 2.69 KB

CONTRIBUTING.md

File metadata and controls

65 lines (52 loc) · 2.69 KB
Raw

Contributing to C Games Collection

Thank you for your interest in contributing to this project! We welcome contributions from anyone who wants to help improve the project, whether you're fixing bugs, adding features, or improving documentation. Please take a moment to read through the following guidelines to help make the process smooth and respectful for everyone.

How to Contribute

To contribute to this project, follow these steps:

1. Fork the repository

Click the "Fork" button at the top-right of this page to create a personal copy of the repository.

2. Create a new branch

Before making any changes, create a new branch for your work:

git checkout -b feature/your-feature-name

3. Make your changes

Make your changes or improvements in the new branch. Be sure to:

  • Write clean, readable code.
  • Add comments where necessary.
  • Follow the coding style used throughout the repository.

4. Test your changes

Ensure that your changes work as expected and don’t break existing functionality. If you're adding a new feature, write tests to confirm its functionality.

5. Commit your changes

Once your changes are ready, commit them with a clear and descriptive commit message:

git add .
git commit -m "Description of changes made"

6. Push your changes

Push your changes to your fork:

git push origin feature/your-feature-name

7. Open a pull request

Go to the original repository and click the "Pull Requests" tab. Then click "New Pull Request." Select your branch from the fork and submit the pull request. In your pull request description, include:

  • A clear explanation of what your changes do.
  • Any relevant issue numbers (e.g., Fixes #45).
  • Any special instructions for the maintainers to review.

Code Style

Please ensure your code adheres to the following conventions:

  • Use consistent indentation (preferably 4 spaces).
  • Use descriptive variable and function names.
  • Avoid hardcoding values. Use constants or configuration files where appropriate.
  • Follow the existing file and folder structure.

Reporting Issues

If you find a bug or have an idea for a new feature, please open an issue in the repository. When reporting a bug, please include:

  • A detailed description of the issue.
  • Steps to reproduce the issue.
  • Any relevant error messages or logs.

Review Process

Once your pull request is submitted, the maintainers will review your changes. Be prepared to:

  • Address any feedback given during the review.
  • Make any necessary changes before your pull request can be merged.

Community Guidelines

  • Be respectful and considerate to others when discussing issues or changes.
  • Avoid making personal attacks or being rude in your comments.