From 08a663edd03310d517f2f313a9499a3d644aa4b3 Mon Sep 17 00:00:00 2001 From: ananya173147 Date: Thu, 19 Oct 2023 13:16:01 -0400 Subject: [PATCH] update documentation --- CONTRIBUTING.md | 30 +++++++++++++++++++++++++++++- src/recommenderapp/app.py | 2 +- 2 files changed, 30 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e6159dd49..fe804a4da 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -54,11 +54,39 @@ - setup.py +## Suggesting Enhancements + +Any suggested enhancements like adding new features or improving existing functionalities, etc can done by following the below guidelines. They help maintainers understand your improvement.
+[the template](https://github.com/atom/.github/blob/master/.github/ISSUE_TEMPLATE/feature_request.md)- this template is to be filled to add suggestions. These can include the steps that you imagine you would take if the feature you're requesting existed. + +##### Before Submitting An Enhancement Suggestion + +[debugging guide](https://flight-manual.atom.io/hacking-atom/sections/debugging/). Check out this debugging guide, which helps you to find the cause of the problem and you may fix it by yourself manually.
+[cursory search](https://github.com/search?q=+is%3Aissue+user%3Aatom) A cursory search is necessary to check if the reported bug has already been mentioned before or not. You can add to the existing bug report if the issue is still open. + +#### To Submit A Good Enhancement Suggestion + +[GitHub issues](https://guides.github.com/features/issues/) You can track the bugs from this. For the repository that has a bug, create an issue and fill out [the template](https://github.com/atom/.github/blob/master/.github/ISSUE_TEMPLATE/bug_report.md) to give details of the bug. + +* To identify the problem, give the issue a clear and informative term.
+* Describe in as much detail as possible to duplicate the problem. Explain the problem and explain the exact command used in the terminal that caused the bug to occur. +* To demonstrate the steps, give specific examples. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, use [Markdown code blocks](https://help.github.com/articles/markdown-basics/#multiple-lines). +* Specify the problem behavior that you expected to see and why. +* If possible, include screenshots and animated GIFs that clearly demonstrate the problem. [this tool](https://www.cockos.com/licecap/)- to record GIFs on macOS and Windows, and [this tool](https://github.com/colinkeenan/silentcast) or [this tool](https://github.com/GNOME/byzanz) on Linux. +* To include a crash report, add a stack trace from the operating system. For macOS, `Console.app` under "Diagnostic and usage information" > "User diagnostic reports" has the crash report. Include the crash report in the issue in a [code block](https://help.github.com/articles/markdown-basics/#multiple-lines), a [file attachment](https://help.github.com/articles/file-attachments-on-issues-and-pull-requests/), or put it in a [gist](https://gist.github.com/) and provide link to that gist. +* For performance or memory issues, include a [CPU profile capture](https://flight-manual.atom.io/hacking-atom/sections/debugging/#diagnose-runtime-performance) with your report. + +#### Start Your Contribution + +`beginner` and `help-wanted` issues can help you get started to making your first contribution: + +* [Beginner issues][beginner] - issues which should only require a few lines of code, and a test or two. +* [Help wanted issues][help-wanted] - issues that should be a bit more involved than `beginner` issues. + ## Style checkers standards: * Use the `pylance` package for Python (VS code), and use `black` for auto-styling and auto-formatting the code. * Use 'pylint' for proper coding standards - ## Code of Conduct: * Please go through the [Code of Conduct](https://github.com/adipai/PopcornPicks/blob/master/CODE_OF_CONDUCT.md) before you begin contributing. This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to popcornpicks504@gmail.com. diff --git a/src/recommenderapp/app.py b/src/recommenderapp/app.py index 22471b4ae..f9744700e 100644 --- a/src/recommenderapp/app.py +++ b/src/recommenderapp/app.py @@ -101,4 +101,4 @@ def success(): if __name__ == "__main__": - app.run(port=5000, debug=True) + app.run(port=5000)