Skip to content
This repository has been archived by the owner on Jul 6, 2020. It is now read-only.

Commit

Permalink
removed_unnecessary_files
Browse files Browse the repository at this point in the history
  • Loading branch information
Kajol-Kumari committed Mar 24, 2020
1 parent 028b20b commit fd0a189
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 36 deletions.
52 changes: 17 additions & 35 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,51 +45,28 @@ git checkout -b your-branch-name
2. Commit and push code to your branch:

- Commits should be self-contained and contain a descriptive commit message.

- 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.

- Please ensure that your code is well tested.

- If you have to check for any linting issues, run the following command before creating the pull request:
```ng lint```

- For running the testcases locally use ```ng test``` command.

- Also, For Pretifying the Frontend Code Use ```HTML/JS/CSS Pretifier```.

- 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```.

3. Once the code is pushed, create a pull request:

- 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.
If the code is mergeable (you get a message saying “Able to merge”), go ahead and create the pull request.

- 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.

- 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.
- Once all comments are addressed, the reviewer will give an LGTM (‘looks good to me’) and merge the PR.

- Once all comments are addressed, the maintainer will approve the PR.

4. Once you get reviewed by a mentor and done with all the required changes, squash all the commits:

```
git checkout <branch_name>
git rebase -i HEAD~N (N is the number of commits to be squashed)
```

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.

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.

```
git push origin <branch_name> --force
```

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

Once rebasing is done, the reviewer will approve and merge the PR.

5. Rules for great commit messages:
4. Rules for great commit messages:

- Write your commit message in the imperative: "Fix bug" and not "Fixed bug" or "Fixes bug."

Expand All @@ -105,21 +82,26 @@ Once rebasing is done, the reviewer will approve and merge the PR.

- Describe why a change is being made.

6. Commit message is important as it should answers/should do the following:
5. Commit message is important as it should answers/should do the following:

- How does it address the issue?

- What effects does the patch have?

- Hints at improved code structure
- hints at improved code structure.

- Provide concise explaination to the user about limitations of the current code, like a bug or an issue

7. Examples of a great commit message:
- Describe limitations of the current code.

- The reader should properly understand why the necessary changes were made.

- Commit messages are crucial as they are a concise explanation of what upgrades have been made.

6. Examples of great commit messages:

- Add CPU arch filter scheduler support
- Fix submission worker crash issue

- Fix crash issue

- Change design template

***Congratulations, you have successfully contributed to Project EvalAI!***
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,6 @@ export class ChallengesettingsComponent implements OnInit {
}
}


validateEmail(email) {
if (email === '') {
return true;
Expand Down

0 comments on commit fd0a189

Please sign in to comment.