-
Notifications
You must be signed in to change notification settings - Fork 45
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Create a README.md #110
Create a README.md #110
Conversation
README.md
Outdated
# Google Code-in 2017 | ||
|
||
*** | ||
Google Code-in 2017 Current Leadersis a platform where anyone can see trending organization's projects under going in GCI 2017 with task completed description,communication link,and top contributor's name. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It is a website to show the current leaders from all organizations in GCI.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
But don't copy and paste my words.
README.md
Outdated
@@ -0,0 +1,47 @@ | |||
# Google Code-in 2017 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Google Code-in Leaders
README.md
Outdated
|
||
### Technologies Used: | ||
|
||
*** |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Languages, libraries, etc. it's in the repo topic.
README.md
Outdated
|
||
### Installation | ||
|
||
*** |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
npm install
to install dependencies
README.md
Outdated
|
||
### Usage: | ||
|
||
*** |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
npm run build
to build the site
README.md
Outdated
|
||
### License | ||
|
||
*** |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
See package.json
Redo your commit; it should be one commit. |
Ideally a PR shouldn't come from your master branch it can complicate things. But don't worry, do not close this one. You can discuss about it in our chat. |
README.md
Outdated
Google Code-in 2017 Current Leadersis a platform where anyone can see trending organization's projects under going in GCI 2017 with task completed description,communication link,and top contributor's name. | ||
*** | ||
|
||
* [Installation]() |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Use -
instead for a listing. coala will complaints about this.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@learneradarsh If you are confused over the content to be added analyse other coala repos and see what and how the content are added there. It might help a lot.
README.md
Outdated
# Google Code-in 2017 | ||
|
||
*** | ||
Google Code-in 2017 Current Leadersis a platform where anyone can see trending organization's projects under going in GCI 2017 with task completed description,communication link,and top contributor's name. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Leaders is
, also space after commas.
README.md
Outdated
|
||
*** | ||
|
||
### Getting Involved |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
See other coala repos to get an idea of what type of content you have to add.
README.md
Outdated
Google Code-in 2017 Current Leadersis a platform where anyone can see trending organization's projects under going in GCI 2017 with task completed description,communication link,and top contributor's name. | ||
*** | ||
|
||
* [Installation]() |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add anchor tags near each subpoint and link them in ()
README.md
Outdated
# Google Code-in 2017 | ||
|
||
*** | ||
Google Code-in 2017 Current Leadersis a platform where anyone can see trending organization's projects under going in GCI 2017 with task completed description,communication link,and top contributor's name. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should probably keep lines to <80 chars.
README.md
Outdated
# Google Code-in Leaders | ||
|
||
*** | ||
It is a website to show the current leaders from all organizations in GCI. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove "It is"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Or replace with "This is" if you prefer
README.md
Outdated
It is a website to show the current leaders from all organizations in GCI. | ||
*** | ||
|
||
* [Installation](###installation) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No. An anchor start with a single #
. Read more here http://assemble.io/docs/Cheatsheet-Markdown.html
done all the requested changes @blazeu |
README.md
Outdated
### License | ||
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) | ||
*** | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove these useless spaces.
README.md
Outdated
|
||
If you are interested in commercial support, please contact us on the Gitter channel as well. | ||
|
||
You can also drop an email at our [mailing list](https://github.com/coala/coala/wiki/Mailing-Lists). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We don't use mailing lists.
README.md
Outdated
### Support | ||
Feel free to contact us at our [Gitter channel](https://gitter.im/coala/coala), we'd be happy to help! | ||
|
||
If you are interested in commercial support, please contact us on the Gitter channel as well. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No, we don't do commercial support for this project.
@@ -0,0 +1,49 @@ | |||
# Google Code-in Leaders | |||
*** |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we remove all of these rulers? They look annoying.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yup as we are already using h1 above this, don't need this.
*** | ||
### Usage: | ||
``` | ||
npm run build |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A better documentation on how to open the freshly built site would be nice
[blazeu](mailto:[email protected]) | ||
*** | ||
### License | ||
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We still haven't added a License to this repo yet.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
And it can be autodetected using shields.io, so may as well do that instead of hardcoding it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
License is MIT according to package.json
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah just found a issue for it #6
README.md
Outdated
### Getting Involved | ||
If you would like to be a part of the coala community, you can check out our [Getting In Touch](http://coala.readthedocs.io/en/latest/Help/Getting_In_Touch.html) page or ask us at our active Gitter channel, where we have maintainers from all over the world. We appreciate any help! | ||
|
||
We also have a [newcomer guide](http://api.coala.io/en/latest/Developers/Newcomers_Guide.html) to help you get started by fixing an issue yourself! If you get stuck anywhere or need some help, feel free to contact us on Gitter or drop a mail at our [newcomer mailing list](https://groups.google.com/forum/#!forum/coala-newcomers). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
as @yukiisbored mentioned we don't use mailing list, you should remove it from here too.
Also @learneradarsh I suggest you rebase and squash your commits too. If you need help with that ping us on zulip/gitter for help. There are 3 PRs for this, close the 2 irrelevant ones. |
Git rebase and squash done |
It seems your commits still 13. Rebase and squash should made the commit into 1. |
23444f0
to
e8a225f
Compare
@learneradarsh Still 2 commits squash them please, btw never press the |
ec10d58
to
e8a225f
Compare
Finally, it's done within one commit. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please update your branch.
Currently your master is 7 commits behind
coala master which means that you will have to update your master with the latest changes that is the reason your PR shows 30 files changed rather it should only show 1.
You're rebase went awry, and you've somehow integrated the changes of the other ~7 commits that happened after you opened this pr. Don't worry, this is easily fixable. First, do |
ping @learneradarsh , GCI is over, but the opportunity to learn continues ;-) |
I've manually fixed this PR. |
ack 429f806 |
merging it as-is; fixups can followup
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not ideal, but better to have this file than not have this file.
@gitmate-bot ff |
Hey! I'm GitMate.io! This pull request is being fastforwarded automatically. Please DO NOT push while fastforward is in progress or your changes would be lost permanently |
This adds a README.md file containing information about the project, including steps for Installation,languages,usage,getting involved, Support,Authors,and License. It helps users to setup and use this project. Closes coala#2
Automated fastforward with GitMate.io was successful! 🎉 |
I've created README.md with basic structure but don't know what type of data I should explain here.
Please let me know about this.
Closes #2