Skip to content

Latest commit

 

History

History
54 lines (35 loc) · 2.35 KB

CONTRIBUTING.md

File metadata and controls

54 lines (35 loc) · 2.35 KB
Raw

Contributing to Roblogic Codespace Template

First of all, thank you for considering contributing to the Roblogic Codespace Template! Your help is greatly appreciated. This document provides guidelines to ensure smooth collaboration within the project.

Table of Contents

  1. Code of Conduct
  2. How to Contribute
  3. Coding Standards
  4. Pull Request Process
  5. Contact

Code of Conduct

Please follow the Code of Conduct to ensure a positive and inclusive environment for all contributors.

How to Contribute

To contribute to the Roblogic Codespace Template, follow these steps:

  1. Fork the repository.
  2. Create a new branch with a descriptive name for your feature or bugfix.
  3. Commit your changes to the new branch.
  4. Create a pull request, describing the changes you've made and their purpose.
  5. Wait for project maintainers to review and merge your changes.

Coding Standards

To maintain a consistent codebase, please adhere to the following coding standards:

React Frontend

  1. Follow the Airbnb React/JSX Style Guide.
  2. Use Prettier and ESLint to ensure consistent formatting and to catch potential issues. The project should already have the necessary configuration files.
  3. Write descriptive and concise commit messages.

Python Backend

  1. Follow the PEP 8 Style Guide for Python Code.
  2. Use Black for code formatting and flake8 for linting. The project should already have the necessary configuration files.
  3. Write descriptive and concise commit messages.

Pull Request Process

  1. Ensure your code follows the coding standards mentioned above.
  2. Update the README.md or other documentation files with the details of any changes you've made, if necessary.
  3. Once your pull request is created, it will be reviewed by the project maintainers. They may provide feedback or request changes.
  4. Address any feedback or requested changes and push them to your branch.
  5. Once your changes are approved, the maintainers will merge your pull request.

Contact

If you have any questions, issues, or suggestions, please open an issue on the GitHub repository.