Skip to content

Latest commit

 

History

History
44 lines (30 loc) · 2.18 KB

CONTRIBUTING.md

File metadata and controls

44 lines (30 loc) · 2.18 KB

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change. Please note we have a code of conduct, please follow it in all your interactions with the project.

Development environment setup

[?] Proceed to describe how to setup local development environment. e.g:

To set up a development environment, please follow these steps:

  1. Clone the repo

    git clone https://github.com/kayac_chang/Where would you like to go today?

  2. TODO

Issues and feature requests

You've found a bug in the source code, a mistake in the documentation or maybe you'd like a new feature?Take a look at [GitHub Discussions](https://github.com/kayac_chang/Where would you like to go today?/discussions) to see if it's already being discussed. You can help us by [submitting an issue on GitHub](https://github.com/kayac_chang/Where would you like to go today?/issues). Before you create an issue, make sure to search the issue archive -- your issue may have already been addressed!

Please try to create bug reports that are:

  • Reproducible. Include steps to reproduce the problem.
  • Specific. Include as much detail as possible: which version, what environment, etc.
  • Unique. Do not duplicate existing opened issues.
  • Scoped to a Single Bug. One bug per report.

Even better: Submit a pull request with a fix or new feature!

How to submit a Pull Request

  1. Search our repository for open or closed [Pull Requests](https://github.com/kayac_chang/Where would you like to go today?/pulls) that relate to your submission. You don't want to duplicate effort.
  2. Fork the project
  3. Create your feature branch (git checkout -b feat/amazing_feature)
  4. Commit your changes (git commit -m 'feat: add amazing_feature') Taiwan Bus Search uses conventional commits, so please follow the specification in your commit messages.
  5. Push to the branch (git push origin feat/amazing_feature)
  6. [Open a Pull Request](https://github.com/kayac_chang/Where would you like to go today?/compare?expand=1)