Skip to content

Commit d2662e6

Browse files
committed
basic django-struct added
1 parent ea8a7e8 commit d2662e6

17 files changed

Lines changed: 282 additions & 0 deletions

README.md

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
# TPC-website
2+
This is the official website of the Programming Club at IIITDM Jabalpur
3+
4+
## Tech Stack
5+
- Frontend - React
6+
- Backend - Django
7+
8+
## Fixing issues
9+
### Step 1: Pick an issue
10+
After selecting an issue
11+
1. Comment on the issue saying that you are working on the issue.
12+
2. We expect you to discuss the approach by comments.
13+
3. Updates or progress on the issue would be nice.
14+
15+
### Step 2: Follow branch policies
16+
1. Create a new branch and switch to it (make sure you are on master before doing this).
17+
```
18+
git branch mybranch
19+
git checkout mybranch
20+
```
21+
'mybranch' can be replaced by your preferred name for the branch or the issue for which it was created.
22+
The above two commands are equivalent to the following
23+
```
24+
git checkout -b mybranch
25+
```
26+
27+
2. Make your changes and then execute the tests to make sure you didn't break anything.
28+
29+
```
30+
python3 manage.py test
31+
```
32+
Ensure that you follow [PEP8](https://www.python.org/dev/peps/pep-0008/#descriptive-naming-styles) style guide for python code while naming functions or classes.
33+
34+
Then stage them and commit them.
35+
Check out Chris Beams's guide to writing good commit messages [here](https://chris.beams.io/posts/git-commit/).
36+
37+
*A small description of your changes is must in the commit messages.*
38+
39+
3. After you are done making changes, push the branch to your fork.
40+
```
41+
git push -u myfork mybranch
42+
```
43+
The **-u** option is required only the first time you push the branch.
44+
45+
Make sure your branch is up-to-date with the latest version of the master. Else you are required to do a rebase to place your changes above master branch.
46+
47+
### Step 3: Follow Coding policy
48+
49+
1. Please help us follow the best practice to make it easy for the reviewer as well as the contributor. We want to focus on the code quality more than on managing pull request ethics.
50+
2. Single commit per pull request
51+
3. For writing commit messages please adhere to the Commit style guidelines.
52+
4. Follow uniform design practices.
53+
5. The pull request will not get merged until and unless the commits are squashed. In case there are multiple commits on the PR, the commit author needs to squash them and not the maintainers cherrypicking and merging squashes.
54+
6. If the PR is related to any front end change, please attach relevant screenshots in the pull request description.
55+
56+
### Step 4: Submitting a Pull request
57+
Once a PR is opened, try and complete it within 2 weeks, or at least stay actively working on it. Inactivity for a long period may necessitate a closure of the PR. As mentioned earlier updates would be nice.
58+
59+
### Step 5: Code Review
60+
61+
Your code will be reviewed, by :
62+
63+
1. Reviewer: A core team member will review your pull request and approve it or he will suggest changes.
64+
65+
### Step 6: Help us by reviewing other Pull Requests!
66+
If you have the time and the knowledge then you must review other Pull Requests. This would stop Pull Requests from stacking up and will definitely mean your Pull Request would be reviewed faster.
67+
68+
**Things to keep in mind while reviewing a Pull Request:**
69+
70+
If any of the following questions has a **YES** for an answer then the request shall **NOT** be approved.
71+
* Will the referenced issue **NOT** be fixed with the Pull Request?
72+
* Is the commit message **NOT** good?
73+
* Are there unnecessary changes?
74+
* Is a rebase required?
75+
* Is the fix dirty / hacky?
76+
77+
## License
78+
79+
This website is licensed under [GPL V3+](https://www.gnu.org/licenses/gpl-3.0.fr.html)
458 KB
Loading
488 KB
Loading
477 KB
Loading
455 KB
Loading
493 KB
Loading
480 KB
Loading
461 KB
Loading
72.4 KB
Loading
16.8 KB
Loading

0 commit comments

Comments
 (0)