You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jul 6, 2020. It is now read-only.
- Commits should be self-contained and contain a descriptive commit message.
48
-
48
+
49
49
- Please make sure your code is well-formatted and adheres to PEP8 conventions (for Python) and the airbnb style guide (for JavaScript). For others (Lua, prototxt etc.) please ensure that the code is well-formatted and the style consistent.
50
-
50
+
51
51
- Please ensure that your code is well tested.
52
-
52
+
53
53
- If you have to check for any linting issues, run the following command before creating the pull request:
54
54
```ng lint```
55
-
56
55
- For running the testcases locally use ```ng test``` command.
57
56
58
57
- Also, For Pretifying the Frontend Code Use ```HTML/JS/CSS Pretifier```.
59
58
60
59
- For installing the Sublime Package Control Manager in Sublime-Text Editor use [this](https://packagecontrol.io/installation#st2) link. Also, If Sublime Package Control Manager is installed then install ```HTML/JS/CSS Pretifier```.
61
-
62
60
3. Once the code is pushed, create a pull request:
63
-
64
61
- On your GitHub fork, select your branch and click “New pull request”. Select “master” as the base branch and your branch in the “compare” dropdown.
65
62
If the code is mergeable (you get a message saying “Able to merge”), go ahead and create the pull request.
66
63
67
64
- Check back after some time to see if the Travis checks have passed, if not you should click on “Details” link on your PR thread at the right of “The Travis CI build failed”, which will take you to the dashboard for your PR. You will see what failed / stalled, and will need to resolve them.
68
65
69
66
- If your checks have passed, your PR will be assigned a reviewer who will review your code and provide comments. Please address each review comment by pushing new commits to the same branch (the PR will automatically update, so you don’t need to submit a new one). Once you are done, comment below each review comment marking it as “Done”. Feel free to use the thread to have a discussion about comments that you don’t understand completely or don’t agree with.
67
+
- Once all comments are addressed, the reviewer will give an LGTM (‘looks good to me’) and merge the PR.
70
68
71
-
- Once all comments are addressed, the maintainer will approve the PR.
72
-
73
-
4. Once you get reviewed by a mentor and done with all the required changes, squash all the commits:
74
-
75
-
```
76
-
git checkout <branch_name>
77
-
git rebase -i HEAD~N (N is the number of commits to be squashed)
78
-
```
79
-
80
-
Then a screen will appear with all N commits having "pick" written in front of every commit.Change pick to s for the last N-1 commits and let it be pick for the first one.
81
-
82
-
Press esc button and type ":wq" to save the change and close the screen. Now a new screen will appear asking you to change commit message. Change it accordingly and save it.
83
-
84
-
```
85
-
git push origin <branch_name> --force
86
-
```
87
-
88
-
For further query regarding rebasing, visit https://github.com/todotxt/todo.txt-android/wiki/Squash-All-Commits-Related-to-a-Single-Issue-into-a-Single-Commit
89
-
90
-
Once rebasing is done, the reviewer will approve and merge the PR.
91
-
92
-
5. Rules for great commit messages:
69
+
4. Rules for great commit messages:
93
70
94
71
- Write your commit message in the imperative: "Fix bug" and not "Fixed bug" or "Fixes bug."
95
72
@@ -105,21 +82,26 @@ Once rebasing is done, the reviewer will approve and merge the PR.
105
82
106
83
- Describe why a change is being made.
107
84
108
-
6. Commit message is important as it should answers/should do the following:
85
+
5. Commit message is important as it should answers/should do the following:
109
86
110
87
- How does it address the issue?
111
88
112
89
- What effects does the patch have?
113
90
114
-
-Hints at improved code structure
91
+
-hints at improved code structure.
115
92
116
-
- Provide concise explaination to the user about limitations of the current code, like a bug or an issue
117
-
118
-
7. Examples of a great commit message:
93
+
- Describe limitations of the current code.
94
+
95
+
- The reader should properly understand why the necessary changes were made.
96
+
97
+
- Commit messages are crucial as they are a concise explanation of what upgrades have been made.
98
+
99
+
6. Examples of great commit messages:
119
100
120
101
- Add CPU arch filter scheduler support
121
-
122
-
- Fix submission worker crash issue
102
+
103
+
- Fix crash issue
123
104
124
105
- Change design template
106
+
125
107
***Congratulations, you have successfully contributed to Project EvalAI!***
0 commit comments