Skip to content

Commit 4639233

Browse files
authored
Created Contributing Guidlines (#3)
1 parent e70cbf6 commit 4639233

File tree

1 file changed

+86
-0
lines changed

1 file changed

+86
-0
lines changed

CONTRIBUTING.md

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
# Contributing Guidlines for our Repository!
2+
3+
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
4+
best of your ability.
5+
6+
## Section 1 | Opening a Issue
7+
8+
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
9+
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.
10+
This checklist is also available on the issue when you create one.
11+
12+
Preview of Issue Template
13+
14+
Checklist
15+
16+
- [ ] Signed CLA (Contributors License Agreement)
17+
- [ ] All commits have been signed.
18+
- [ ] There isn't a pull request with the same solution to the PR or issue.
19+
- [ ] You have read the files README.md and CONTRIBUTING.md
20+
21+
PR Information
22+
- [ ] Repository Changes
23+
- [ ] Python File
24+
- [ ] Other(s), please specify
25+
26+
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.
27+
28+
Python File Sections Changes
29+
30+
- [ ] Variables
31+
- [ ] Error (Input)
32+
- [ ] Imports
33+
- [ ] Definitons
34+
- [ ] User Input
35+
- [ ] Solving
36+
37+
## Section 2 | Collaborating on a Issue
38+
39+
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
40+
, 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
41+
branches are protected that would require the status check.
42+
43+
## Section 3 | Opening a PR
44+
45+
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
46+
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.
47+
This checklist is also available on the PR when you create one.
48+
49+
Checklist
50+
51+
- [ ] Signed CLA (Contributors License Agreement)
52+
- [ ] All commits have been signed.
53+
- [ ] There isn't a pull request with the same solution to the PR or issue.
54+
- [ ] You have read the files README.md and CONTRIBUTING.md
55+
56+
PR Information
57+
- [ ] Repository Changes
58+
- [ ] Python File
59+
- [ ] Other(s), please specify
60+
61+
62+
63+
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.
64+
65+
Python File Sections Changes
66+
67+
- [ ] Variables
68+
- [ ] Error (Input)
69+
- [ ] Imports
70+
- [ ] Definitons
71+
- [ ] User Input
72+
- [ ] Solving
73+
74+
Information About PR
75+
76+
What is the issue about?
77+
78+
79+
80+
81+
82+
Are there any linking issues or PRs?
83+
84+
Thanks for reading! Have a good day!
85+
86+

0 commit comments

Comments
 (0)