Skip to content

Latest commit

 

History

History
107 lines (68 loc) · 3.08 KB

CONTRIBUTING.md

File metadata and controls

107 lines (68 loc) · 3.08 KB

Contributing to Universal Transit Platform

We appreciate your interest in contributing to the Universal Transit Platform! This guide will help you get started with the contribution process.

Table of Contents

Code of Conduct

Please read our Code of Conduct before contributing. We expect all contributors to adhere to these guidelines to maintain a welcoming and productive environment.

How to Contribute

Fork the Repository

Click the "Fork" button at the top right corner of the repository page to create your own copy of the project.

Create a Branch

In your local repository, create a new branch for your feature or bug fix:

git checkout -b feature/your-feature-name

Replace your-feature-name with a descriptive name for your feature.

Make Changes

Make your changes or additions to the codebase. Ensure that you:

  • Write clear and concise code.
  • Include comments and docstrings where necessary.
  • Update or add tests to cover your changes.

Commit Changes

Stage your changes and commit them with a meaningful commit message:

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

Push to GitHub

Push your branch to your GitHub fork:

git push origin feature/your-feature-name

Submit a Pull Request

  1. Navigate to your fork on GitHub.
  2. Click on the "Compare & pull request" button.
  3. Provide a clear and detailed description of your changes.
  4. Submit the pull request.

Our team will review your pull request and provide feedback or merge it as appropriate.

Coding Standards

  • Code Style: Follow PEP 8 guidelines for Python code.

  • Documentation: Use clear and descriptive docstrings for functions, classes, and modules.

  • Testing: Write unit tests for new features and ensure existing tests pass by running:

    pytest tests

  • Dependencies: Avoid adding unnecessary dependencies. If a new package is required, justify its inclusion in your pull request.

Communication

  • Issues: Use GitHub Issues to report bugs or request features.
  • Pull Requests: Engage in discussions on pull requests by providing constructive feedback.
  • Direct Contact: For sensitive matters, you can contact the maintainers at universaltransitplatform@gmail.com.

License

By contributing, you agree that your contributions will be licensed under the MIT License.

Thank you for your contributions! Together, we can make public transportation more accessible worldwide.