Skip to content

Latest commit

 

History

History
executable file
·
81 lines (58 loc) · 7.31 KB

CONTRIBUTING.md

File metadata and controls

executable file
·
81 lines (58 loc) · 7.31 KB
Raw

Contributing to MyDollarBot

Follow the set of guidelines below to contribute to MyDollarBot!

Code of Conduct

This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to upload this code. Please report unacceptable behavior to [email protected].

Prerequistes required before starting this project:

If you like our project and would like to contribue otherwise, please note:

  1. This project is created as part of CSC510 Coursework at NC State for Fall'21.
  2. If you like to contribute, reach out to the maintainers before creating a branch, to confirm if we're still maintaining the repo.
  3. Have good understanding of Python Programming Language and Telegram Bots

How can I Contribute -

Pull Request Process

  1. Pass all the test cases that we have mentioned in the test.py.
  2. Update the README.md with the changes you have made.
  3. Add all the unnecessary build files have to the .gitignore file.
  4. Mention any new installatiuon dependencies in the requirements.txt file.

Committing Changes

  1. You need to start an issue on the project kanban board.
  2. You need to move this issue from to_do to in progress.
  3. Create a new branch and clone the repository.
  4. Change the branch of the code using git checkout.
  5. Make the required changes and commit everything to the newly created branch.
  6. Create a new pull request.

Reporting Bugs

This section gives detailed information on how to report bugs. Reporting a bug will help the community and maintainers of the repository.
Before reporting any bug, make sure it is correct and you have all the details with you. Fot creating any bug report, please fill out the required template. This template will give us necessary information to help solve a bug faster.

Before Submitting A Bug Report

The following is a list of items you need to check before submitting a bug report.

Check out this debugging guide, which helps you to find the cause of the problem and you may fix it by yourself manually.
A cursory search is necessary to check if the reported bug is already mentioned before or not. You can add to the existing bug report if the issue is still open.

To Submit A Good Bug Report

GitHub issues You can track the bugs from this. For the repository that has bug, create an issue and fill out the template 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 about the exact command sused in the terminal which caus ethe 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.
  • Specify what is the problem beavior and what you expected to see and why
  • If possible, include screenshots and animated GIFs that clearly demonstrate the problem. this tool- to record GIFs on macOS and Windows, and this tool or this tool 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 crash report. Include the crash report in the issue in a code block, a file attachment, or put it in a gist and provide link to that gist.

Provide more context by answering these questions:

  • If the problem started happening recently then try downloading the old version of the packages and the code.
  • Include details about your configuration and environment.
  • What is the name and version of the OS you're using?
  • Are you running the project in a virtual environment?
  • Which packages have installed in your system? You can get a list of packages installed by running 'apm list --installed'

Suggesting Enhancements

Any suggesting enhancements like adding new features or imporving existing functionalities, etc can done by following the below guidelines. They help maintainers understand your improvement.
the template- 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

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 A cursory search is necessary to check if the reported bug is already 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 You can track the bugs from this. For the repository that has bug, create an issue and fill out the template 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 about the exact command sused in the terminal which caus ethe 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.
  • Specify what is the problem beavior and what you expected to see and why
  • If possible, include screenshots and animated GIFs that clearly demonstrate the problem. this tool- to record GIFs on macOS and Windows, and this tool or this tool 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 crash report. Include the crash report in the issue in a code block, a file attachment, or put it in a gist and provide link to that gist.
  • For performance or memory issues, include a CPU profile capture with your report.