diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md new file mode 100644 index 0000000..3962691 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -0,0 +1,54 @@ +--- +name: Bug Report +about: Template for Bug Reporting +title: "[BUG] - " +labels: 'Bug :robot:, Good First Issue :new:' +assignees: ryantwt07 + +--- + +*## Checklist + +- [ ] Signed CLA (Contributors License Agreement) +- [ ] All commits have been signed. +- [ ] There isn't a pull request with the same solution to the PR or issue. +- [ ] You have read the files README.md and CONTRIBUTING.md + +## PR Information +- [ ] Repository Changes +- [ ] Python File +- [ ] Other(s), please specify + +
+ +If you have anwer Python File for the above question, please answer the next question. If not, leave the next one blank and continue on to the next question. + +## Python File Sections Changes + +- [ ] Variables +- [ ] Error (Input) +- [ ] Imports +- [ ] Definitons +- [ ] User Input +- [ ] Solving + +## Information About PR + +### What is the issue about? + + + + + +### Are there any linking issues or PRs? + + + +### How to Reproduce Bug? + + + + + + + diff --git a/.github/ISSUE_TEMPLATE/error-report.md b/.github/ISSUE_TEMPLATE/error-report.md new file mode 100644 index 0000000..f3712f6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/error-report.md @@ -0,0 +1,54 @@ +--- +name: Error Report +about: Template for Error Reporting +title: "[ERR] - " +labels: 'Bug :robot:, Good First Issue :new:' +assignees: ryantwt07 + +--- + +## Checklist + +- [ ] Signed CLA (Contributors License Agreement) +- [ ] All commits have been signed. +- [ ] There isn't a pull request with the same solution to the PR or issue. +- [ ] You have read the files README.md and CONTRIBUTING.md + +## PR Information +- [ ] Repository Changes +- [ ] Python File +- [ ] Other(s), please specify + +
+ +If you have anwer Python File for the above question, please answer the next question. If not, leave the next one blank and continue on to the next question. + +## Python File Sections Changes + +- [ ] Variables +- [ ] Error (Input) +- [ ] Imports +- [ ] Definitons +- [ ] User Input +- [ ] Solving + +## Information About PR + +### What is the issue about? + + + + + +### Are there any linking issues or PRs? + + + +### Given Error + + + + + + + diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md new file mode 100644 index 0000000..880ad11 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -0,0 +1,54 @@ +--- +name: Feature Request +about: Template for Feature Request +title: "[FTR] - " +labels: 'Good First Issue :new:, New Feature :1st_place_medal:' +assignees: Rubikscube2007 + +--- + +## Checklist + +- [ ] Signed CLA (Contributors License Agreement) +- [ ] All commits have been signed. +- [ ] There isn't a pull request with the same solution to the PR or issue. +- [ ] You have read the files README.md and CONTRIBUTING.md + +## PR Information +- [ ] Repository Changes +- [ ] Python File +- [ ] Other(s), please specify + +
+ +If you have anwer Python File for the above question, please answer the next question. If not, leave the next one blank and continue on to the next question. + +## Python File Sections Changes + +- [ ] Variables +- [ ] Error (Input) +- [ ] Imports +- [ ] Definitons +- [ ] User Input +- [ ] Solving + +## Information About PR + +### What is the issue about? + + + + + +### Are there any linking issues or PRs? + + + +### Feature you wish to add. + + + + + + + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..a1f0a99 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,86 @@ +# Contributing Guidlines for our Repository! + +By starting a issue or making a pull request, you hereby acknowledge that you have read this file fully and you will abide by the rules stated in this document to the +best of your ability. + +## Section 1 | Opening a Issue + +When opening a issue, you are required to use the issue templates. If your issue does not relate to any of the issue templates, please open a feature request issue +using the feature request template. You are also required to fill up the template fully and ensure that you truefully conduct the checklist as stated below. +This checklist is also available on the issue when you create one. + +Preview of Issue Template + +Checklist + +- [ ] Signed CLA (Contributors License Agreement) +- [ ] All commits have been signed. +- [ ] There isn't a pull request with the same solution to the PR or issue. +- [ ] You have read the files README.md and CONTRIBUTING.md + +PR Information +- [ ] Repository Changes +- [ ] Python File +- [ ] Other(s), please specify + +If you have anwer Python File for the above question, please answer the next question. If not, leave the next one blank and continue on to the next question. + +Python File Sections Changes + +- [ ] Variables +- [ ] Error (Input) +- [ ] Imports +- [ ] Definitons +- [ ] User Input +- [ ] Solving + +## Section 2 | Collaborating on a Issue + +If you wish to start on a Issue, go to Discussions and create a new chat room for the issue. The title of the issue should include the ticket number,the Github # number +, and the title of the issue. The collaborator shall open a new branch in this repository and name the repository after the ticket number, e.g. Ticket 1 etc. These +branches are protected that would require the status check. + +## Section 3 | Opening a PR + +When opening a pull request, you are required to use the pull request template. If your pull request does not relate to the pull, please open a feature request issue +using the feature request template. You are also required to fill up the template fully and ensure that you truefully conduct the checklist as stated below. +This checklist is also available on the PR when you create one. + +Checklist + +- [ ] Signed CLA (Contributors License Agreement) +- [ ] All commits have been signed. +- [ ] There isn't a pull request with the same solution to the PR or issue. +- [ ] You have read the files README.md and CONTRIBUTING.md + +PR Information +- [ ] Repository Changes +- [ ] Python File +- [ ] Other(s), please specify + + + +If you have anwer Python File for the above question, please answer the next question. If not, leave the next one blank and continue on to the next question. + +Python File Sections Changes + +- [ ] Variables +- [ ] Error (Input) +- [ ] Imports +- [ ] Definitons +- [ ] User Input +- [ ] Solving + +Information About PR + +What is the issue about? + + + + + +Are there any linking issues or PRs? + +Thanks for reading! Have a good day! + + diff --git a/README.md b/README.md index 8648439..d7c084e 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,11 @@ -# python-calculator -Need a calculator to calculate Math equations? Or do you need to start your Github journey? Then this is the repository for you! +# Python Calculator + +This is a project repository maintained by [Ryan](https://github.com/ryantwt07) and [Glenn](https://github.com/Rubikscube2007)! + +## About the Repo + +This software is created using Python! This calculator is easy to edit for new Python learners and also, is easy to use! + +## Contributing + +If you wish to contribute, please check out CONTRIBUTING.md.