Skip to content

Latest commit

 

History

History
61 lines (50 loc) · 3.06 KB

CONTRIBUTING.md

File metadata and controls

61 lines (50 loc) · 3.06 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

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

  1. Fork the GitHub Group Project Repository
  2. Clone your Fork using 
    git clone https://github.com/YOUR_GITHUB_USERNAME_HERE/CS386-Project.git
  3. Switch to the dev branch using git checkout -b dev
  4. cd CS386-Project
    • Linux/MacOS: python -m venv .venv
    • On Linux, you will need the python#.##-full package and/or python-is-python3 in order to setup dev environment.
    • On MacOS, use python3 instead. You may need to homebrew Python or install via installer on Python's Website
    • Windows: py -3 -m venv .venv You will need to install Python, and make sure to add to PATH environment variables. If having trouble because the Microsoft Store keeps opening, use the following article: Microsoft Store keeps opening when I type Python
    • Linux/MacOS: . .venv/bin/activate
    • Windows: .venv\Scripts\activate
  7. pip install -r requirements.txt
  8. Run the application in dev/debug mode with the command 
    flask --app ssts run --debug

Note: Debug mode will reload on py file changes, great for developing in real time.

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? You can help us by submitting an issue on GitHub. 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 that relate to your submission. You don't want to duplicate effort.
  2. Fork the project
  3. Checkout the dev branch (git checkout -b dev) This is where all new features go!
  4. Commit your changes (git commit -m 'feat: add amazing_feature') Super Simple Ticketing System [SSTS] uses a simple .
  5. Push to the branch (git push origin dev)
  6. Open a Pull Request
  7. If the feature/fix is accepted, the change will then move to the canary branch to be tested before moving to stable/main to be included as a rolling release.