-
Notifications
You must be signed in to change notification settings - Fork 273
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
d2106b4
commit e3808de
Showing
5 changed files
with
65 additions
and
58 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -30,4 +30,4 @@ javascript_strictness = implied | |
|
|
||
| [md] | ||
| bears = MarkdownBear | ||
| files = **.md, **.markdown | ||
| files = **.md | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,49 +1,56 @@ | ||
| #Contributing to [gci16.fossasia.org](http://gci16.fossasia.org/) | ||
| # Contributing to [gci16.fossasia.org](http://gci16.fossasia.org/) | ||
|
|
||
| ## Code practices | ||
|
|
||
| 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. | ||
|
|
||
| * [People before code](http://hintjens.com/blog:95): If any of the following rules are violated, the pull-requests must not be rejected. This is to create an easy and joyful onboarding process for new programmers and first-time contributors. | ||
| - [People before code](http://hintjens.com/blog:95): If any of the following rules are violated, the pull-requests must not be rejected. This is to create an easy and joyful onboarding process for new programmers and first-time contributors. | ||
|
|
||
| * Single commit per pull request and name the commit as something meaningful, example: `Adding <-your-name-> in students/mentors/blogs section`. | ||
| - Single commit per pull request and name the commit as something meaningful, example: `Adding <-your-name-> in students/mentors/blogs section`. | ||
|
|
||
| * Reference the issue numbers in the commit message if it resolves an open issue. Follow the pattern ``` Fixes #<issue number> <commit message>``` | ||
| - Reference the issue numbers in the commit message if it resolves an open issue. Follow the pattern `Fixes #<issue number> <commit message>` | ||
|
|
||
| * Provide the link to live `gh-pages` from your forked repository or relevant screenshot for easier review. | ||
| - Provide the link to live `gh-pages` from your forked repository or relevant screenshot for easier review. | ||
|
|
||
| * The PR should also include a link to the Google Code-In Task instance (if applicable) to fasten the review process both sides. | ||
| - The PR should also include a link to the Google Code-In Task instance (if applicable) to fasten the review process both sides. | ||
|
|
||
| * In case there are multiple commits on the PR, the commit author should squash them. | ||
| - In case there are multiple commits on the PR, the commit author should squash them. | ||
|
|
||
| * Pull Request older than 4 days with no response from the contributor shall be marked closed. | ||
| - Pull Request older than 4 days with no response from the contributor shall be marked closed. | ||
|
|
||
| * Avoid duplicate PRs, if need be comment on the older PR with the PR number of the follow-up (new PR) and close the obsolete PR yourself. | ||
| - Avoid duplicate PRs, if need be comment on the older PR with the PR number of the follow-up (new PR) and close the obsolete PR yourself. | ||
|
|
||
| For further discussions & communications, please join us on FOSSASIA Slack at #gci channel, link: https://fossasia.slack.com/messages/gci. | ||
| For further discussions & communications, please join us on FOSSASIA Slack at #gci channel, link: <https://fossasia.slack.com/messages/gci>. | ||
| You can get an invite [here](http://fossasia-slack.herokuapp.com/). | ||
|
|
||
| Also, we have a [team of maintainers](maintainers.md) to whom you can write with `@fossasia/gci16-maintainers` | ||
| if your pull-request goes unnoticed. They may have time. | ||
|
|
||
| ## Tutorials | ||
|
|
||
| ### Command Line Tutorials | ||
| * [OpenHatch Missions](https://openhatch.org/missions/) | ||
|
|
||
| - [OpenHatch Missions](https://openhatch.org/missions/) | ||
|
|
||
| ### Git/Github Tutorials | ||
|
|
||
| ### Git: Introduction | ||
| * [Git - the simple guide (awesome)](http://rogerdudler.github.io/git-guide/) | ||
| * [An Intro to Git and GitHub for Beginners (Tutorial)](http://product.hubspot.com/blog/git-and-github-tutorial-for-beginners) | ||
|
|
||
| - [Git - the simple guide (awesome)](http://rogerdudler.github.io/git-guide/) | ||
| - [An Intro to Git and GitHub for Beginners (Tutorial)](http://product.hubspot.com/blog/git-and-github-tutorial-for-beginners) | ||
|
|
||
| #### Github: Introduction | ||
| * [An Intro to Git and GitHub for Beginners (Tutorial)](http://product.hubspot.com/blog/git-and-github-tutorial-for-beginners) | ||
| * [Github Hello World](https://guides.github.com/activities/hello-world/) | ||
| * [Changing a commit message](https://help.github.com/articles/changing-a-commit-message/) | ||
|
|
||
| - [An Intro to Git and GitHub for Beginners (Tutorial)](http://product.hubspot.com/blog/git-and-github-tutorial-for-beginners) | ||
| - [Github Hello World](https://guides.github.com/activities/hello-world/) | ||
| - [Changing a commit message](https://help.github.com/articles/changing-a-commit-message/) | ||
|
|
||
| ### Merge Commits | ||
| * [How To Manually Fix Git Merge Conflicts (video)](https://www.youtube.com/watch?v=g8BRcB9NLp4) | ||
|
|
||
| - [How To Manually Fix Git Merge Conflicts (video)](https://www.youtube.com/watch?v=g8BRcB9NLp4) | ||
|
|
||
| #### Squash Commits | ||
| * [Git Rebase (squash last commit)](https://www.youtube.com/watch?v=qh9KtjfjzCU) | ||
| * [Squash Commits with Git](https://davidwalsh.name/squash-commits-git) | ||
|
|
||
| - [Git Rebase (squash last commit)](https://www.youtube.com/watch?v=qh9KtjfjzCU) | ||
| - [Squash Commits with Git](https://davidwalsh.name/squash-commits-git) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,42 +1,36 @@ | ||
| Maintainers | ||
| =========== | ||
| # Maintainers | ||
|
|
||
| You can view a [team of maintainers for repository](https://github.com/orgs/fossasia/teams/gci16-maintainers). | ||
|
|
||
| Responsibilities of Maintainers | ||
| ------------------------------- | ||
| ## Responsibilities of Maintainers | ||
|
|
||
| - Do not frustrate contributors: Find out what they need, help them help themselves. | ||
| - Guide new contributors. They usually do not comply to the rules and forcing them onto them can be frustrating. | ||
| - Be empathic: Better a bad PR with follow-up PRs than a closed PR and a rejected person. | ||
| - Merge pull-requests. | ||
| - Make sure people understand that you can not accept their GCI task. | ||
|
|
||
| Not a responsibilty of a maintainer | ||
| ----------------------------------- | ||
| ## Not a responsibilty of a maintainer | ||
|
|
||
| - review pull-requests: Anyone can do this, it does not need a maintainer. | ||
| - reject pull-requests: | ||
| - Just do not merge them if you do not like them. | ||
| - If they get old, they are closed. | ||
| - Merge them and revert them to make the requester to a contributor in the future. | ||
|
|
||
| Abilities of Maintainers | ||
| ------------------------ | ||
| ## Abilities of Maintainers | ||
|
|
||
| - Close old pull-requests, see [CONTRIBUTING.md](CONTRIBUTING.md) | ||
| - Remove merged branches. | ||
| - Maintainers can merge their own pull-requests only if they waited for one day. | ||
|
|
||
| Notes for Mantainers | ||
| -------------------- | ||
| ## Notes for Mantainers | ||
|
|
||
| - If a PR edits index.html, it will fail for security. To remove that error, add ```<!-- Safe Edit -->``` somewhere in the PR body. See [#349](https://github.com/fossasia/gci16.fossasia.org/issues/349) for more info. | ||
| - If a PR edits index.html, it will fail for security. To remove that error, add `<!-- Safe Edit -->` somewhere in the PR body. See [#349](https://github.com/fossasia/gci16.fossasia.org/issues/349) for more info. | ||
| - If you want to merge a PR but the commits aren't squashed, please use Github squash and merge function rather than merging without squashing. Check [#402](https://github.com/fossasia/gci16.fossasia.org/issues/402) for more info. | ||
| - If Travis is failing, check **_WHY_** -- if for example jekyll reports a syntax error and won't build, **_do not_** merge it. There are few (if any) circumstances where a failing Travis build should be merged. | ||
| - If Travis is failing, check ***WHY*** -- if for example jekyll reports a syntax error and won't build, ***do not*** merge it. There are few (if any) circumstances where a failing Travis build should be merged. | ||
| - After the PR is merged, update or close the refered issue. | ||
|
|
||
| Further Reading | ||
| --------------- | ||
| ## Further Reading | ||
|
|
||
| [Optimistic Merging](http://hintjens.com/blog:106) |