Skip to main content

Contributing to City Skylines Mods

Welcome​

Thank you for your interest in contributing to City Skylines Mods by Tec de Monterrey, campus Querétaro! We welcome all contributions, including bug fixes, new features, and documentation improvements.

Setting Up Your Development Environment​

Prerequisites​

Installation​

  1. Clone or Fork the repository
  2. Clone your fork locally: git clone https://github.com/City-Skylines-Modding/City-Skylines-Mod.git
  3. Navigate to the directory: cd City-Skylines-Mod
  4. Install any necessary dependencies
  5. Open the project in Visual Studio 2022
  6. Creating new branches: git checkout -b <branch-name>

Contributing Guidelines​

  1. Ensure your changes do not break existing functionality. Run the tests if available.
  2. Ensure your changes are consistent with the overall project architecture.
  3. Ensure your changes are consistent with the coding style of the rest of the project.
  4. Ensure your changes do not add unnecessary dependencies.
  5. Ensure your code is properly documented and commented.
  6. Update any relevant documentation to reflect your changes
  7. Ensure your changes do not introduce any security vulnerabilities.
  8. Ensure your changes are not unnecessarily complex.
  9. Ensure your changes do not duplicate existing code.
  10. Ensure your changes are not overly optimized.
  11. Ensure your changes are not overly generic.
  12. Ensure your changes are not overly opinionated.
  13. Ensure your changes are not overly coupled.
  14. Ensure your changes are not overly abstracted.
  15. Ensure your changes are not overly complicated.
  16. Ensure your changes are not overly clever.

Bug Reports​

  1. Ensure the bug was not already reported by searching on GitHub under Issues
  2. If you're unable to find an open issue addressing the problem, open a new one. Be sure to use the template provided when opening an issue.

Commits​

Each commit message consists should be in the following format commit message standards.

Pull Requests​

Code of Conduct​

In order to foster an inclusive, kind, harassment-free, and cooperative community, we enforce this code of conduct on our open source projects.

Our Pledge​

Please adhere to the project's Code of Conduct. Ensure that your interactions with the community are respectful and positive.

Thank you for contributing to City-Skyline-Mod!