Skip to content

Latest commit

 

History

History
59 lines (32 loc) · 2.43 KB

CONTRIBUTING.md

File metadata and controls

59 lines (32 loc) · 2.43 KB
Raw

Contributing to CityByte SE_Project1

Follow the set of guidelines below to contribute to CityByte SE_Project1!

Code of Conduct

By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

Prerequistes required before starting this project

  1. Must be a graduate student at NC State University
  2. Must be a student in Software Engineering Course in Fall 2022
  3. Have proficiency in Python, HTML, CSS, JavaScript, BootStrap and Django

How can I Contribute -

Reporting Bugs

This section guides you through submitting a bug report for CityByte SE_Project1. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior and find related reports.

  • Before Submitting A Bug Report

  • Check the debugging guide

  • Check the FAQs on the forum for a list of common questions and problems.

  • Determine which repository the problem should be reported in.

  • Perform a cursory search to see if the problem has already been reported.

How Do I Submit A (Good) Bug Report?

  • Use a clear and descriptive title for the issue to identify the problem.

  • Describe the exact steps which reproduce the problem in as many details as possible.

  • Provide specific examples to demonstrate the steps.

  • Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.

  • Explain which behavior you expected to see instead and why.

  • Include screenshots and animated GIFs which show you following the described steps and clearly demonstrate the problem.

  • If the problem is related to performance or memory, include a CPU profile capture with your report.

Pull Requests

The process described here has several goals:

  • Maintain the projects quality

  • Fix problems that are important to users

  • Enable a sustainable system for the projects maintainers to review contributions

How can the project be extended?

The project can be extended by adding multiple features without changing the current source code. This can be done by writing the backend logic in the views.py file and the frontend part in the templates file of the django project. Apart from that the performance can be improved by caching results from API using redix. The search bar can be added based on the category filter which can make the project more user friendly. To run multiple api simultaneously, multithreading can also be implemented.