Skip to content
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

Add Algorithms Education #1301

Merged
merged 5 commits into from
Jun 15, 2019
Merged

Add Algorithms Education #1301

merged 5 commits into from
Jun 15, 2019

Conversation

gaerae
Copy link
Contributor

@gaerae gaerae commented May 15, 2018

https://github.com/gaerae/awesome-algorithms-education

A curated list to learning and practicing about algorithm.

By submitting this pull request I confirm I've read and complied with the below requirements 🖖

Please read it multiple times. I spent a lot of time on these guidelines and most people miss a lot.

Requirements for your pull request

  • I have read and understood the contribution guidelines and the instructions for creating a list.
  • This pull request has a descriptive title.
    For example, Add Name of List, not Update readme.md or Add awesome list.
  • The entry in the Awesome list should:
    • Include a short description about the project/theme of the list. It should not describe the list itself.
      Example: - [Fish](…) - User-friendly shell., not - [Fish](…) - Resources for Fish..
    • Be added at the bottom of the appropriate category.
  • The list I'm submitting complies with these requirements:

Requirements for your Awesome list

  • Has been around for at least 30 days.
    That means 30 days from either the first real commit or when it was open-sourced. Whatever is most recent.
  • It's the result of hard work and the best I could possibly produce.
  • Non-generated Markdown file in a GitHub repo.
  • Includes a succinct description of the project/theme at the top of the readme. (Example)
  • The repo should have awesome-list & awesome as GitHub topics. I encourage you to add more relevant topics.
  • Not a duplicate.
  • Only has awesome items. Awesome lists are curations of the best, not everything.
  • Includes a project logo/illustration whenever possible.
    • Either fullwidth or placed at the top-right of the readme. (Example)
    • The image should link to the project website or any relevant website.
    • The image should be high-DPI. Set it to maximum half the width of the original image.
  • Entries have a description, unless the title is descriptive enough by itself. It rarely is though.
  • Includes the Awesome badge.
    • Should be placed on the right side of the readme heading.
    • Should link back to this list.
  • Has a Table of Contents section.
    • Should be named Contents, not Table of Contents.
    • Should be the first section in the list.
    • Should only have one level of sub-lists, preferably none.
  • Has an appropriate license.
    • That means something like CC0, not a code licence like MIT, BSD, Apache, etc.
    • WTFPL and Unlicense are not acceptable licenses.
    • If you use a license badge, it should be SVG, not PNG.
  • Has contribution guidelines.
    • The file should be named contributing.md. Casing is up to you.
  • Has consistent formatting and proper spelling/grammar.
    • The link and description are separated by a dash.
      Example: - [AVA](…) - JavaScript test runner.
    • The description starts with an uppercase character and ends with a period.
    • Consistent and correct naming. For example, Node.js, not NodeJS or node.js.
  • Doesn't include a Travis badge.
    You can still use Travis for list linting, but the badge has no value in the readme.

Go to the top and read it again.

@legodude17
Copy link

Judges

What does this mean?

@gaerae
Copy link
Contributor Author

gaerae commented May 15, 2018

@legodude17
online judge is an online system to test programs in programming contests.
wikipedia: Onlinejudge

changed judges to online judges.

The description starts with an uppercase character and ends with a period.
@legodude17
Copy link

Would it be possible to add some descriptions to the online judges? Like, what makes them unique, the difficulty, and so on.

@gaerae
Copy link
Contributor Author

gaerae commented May 15, 2018

Done. added description.

Online judges

An Online Judging system is an online system to test programs in programming contests automatically.

@sindresorhus
Copy link
Owner

Hey, sorry for the lack of response, please see #1363.

@gaerae
Copy link
Contributor Author

gaerae commented Jul 29, 2018

Reviewed #1363! @sindresorhus
Also fixed merge conflicts.

@sindresorhus sindresorhus changed the title Add algorithm education Add Algorithms Education Aug 17, 2018
@sindresorhus
Copy link
Owner

Would it be possible to add some descriptions to the online judges? Like, what makes them unique, the difficulty, and so on.
Done. added description.

He meant a description per item, not just a description of the section.

@sindresorhus
Copy link
Owner

Javascript => JavaScript Youtube=>YouTube Github=>GitHub`

@sindresorhus
Copy link
Owner

The header image should be centered and you don't need the text header.

@sindresorhus
Copy link
Owner

The link and description are separated by a dash.
Example: - AVA - JavaScript test runner.

@sindresorhus
Copy link
Owner

Includes a project logo/illustration whenever possible.
The image should be high-DPI. Set it to maximum half the width of the original image.

@sindresorhus
Copy link
Owner

Includes a succinct description of the project/theme at the top of the readme. (Example)

@gaerae
Copy link
Contributor Author

gaerae commented Aug 19, 2018

@sindresorhus Please confirm.

  • He meant a description per item, not just a description of the section.
  • Online judges → Competitive programming
  • Javascript → JavaScript, Youtube → YouTube, Github → GitHub`
  • The link and description are separated by a dash.
  • Includes a project logo/illustration whenever possible. → Removed logo image.
  • Includes a succinct description of the project/theme at the top of the readme.

@sindresorhus
Copy link
Owner

❯ awesome-lint https://github.com/gaerae/awesome-algorithms
✖ Linting

  readme-en.md:74:3
  ✖   10:3    ToC item "Introductory" missing corresponding heading                                       remark-lint:awesome/toc
  ✖   25:93   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖   26:99   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖   27:143  List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖   30:116  List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖   31:65   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖   32:94   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖   33:181  List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖   34:164  List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖   35:84   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖   36:111  List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖   37:81   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖   38:82   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖   39:83   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖   40:84   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖   43:120  List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖   44:94   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖   47:62   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖   48:51   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖   49:39   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖   50:38   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖   51:39   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖   52:38   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖   53:37   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖   54:38   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖   55:62   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖   56:38   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖   57:81   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖   58:45   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖   59:39   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖   60:36   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖   61:73   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖   62:57   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖   63:54   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖   64:36   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖   65:33   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖   66:52   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖   67:43   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖   68:36   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖   69:61   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖   70:44   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖   71:48   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖   72:38   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖   73:35   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖   74:3    Link to http://judge.lavida.us is dead                                                      remark-lint:no-dead-urls
  ✖   74:35   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖   75:36   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖   76:36   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖   77:34   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖   78:29   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖   79:42   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖   80:60   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖   81:43   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖   82:55   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖   85:62   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖   86:103  List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖   87:35   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖   88:42   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖   89:68   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖   90:98   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖   91:88   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖   92:31   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖   93:86   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖   94:64   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖   95:75   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖   96:60   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖  101:84   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖  102:81   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖  103:113  List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖  106:106  List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖  107:73   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖  108:107  List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖  109:118  List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖  110:111  List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖  111:59   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖  112:69   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖  113:67   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖  116:67   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖  117:105  List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖  118:3    Link to https://www.digitalculture.or.kr/koi/StudyBook.do is dead                           remark-lint:no-dead-urls
  ✖  118:88   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖  119:136  List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖  120:137  Link to https://www.hackerrank.com/domains/tutorials/cracking-the-coding-interview is dead  remark-lint:no-dead-urls
  ✖  120:227  List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖  125:69   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖  128:3    Link to http://www.stoimen.com/blog/category/algorithms is dead                             remark-lint:no-dead-urls
  ✖  128:71   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖  129:170  List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖  130:144  List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖  131:63   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖  140:47   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖  141:40   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖  142:46   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖  143:68   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖  144:48   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖  147:95   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖  148:67   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖  150:78   List item description must end with proper punctuation                                      remark-lint:awesome/list-item
  ✖  151:87   List item description must end with proper punctuation                                      remark-lint:awesome/list-item

  99 errors

https://github.com/sindresorhus/awesome-lint

@sindresorhus
Copy link
Owner

The links in the Contents section should not be bold.

@gaerae
Copy link
Contributor Author

gaerae commented Feb 26, 2019

@sindresorhus Modified.

❯ awesome-lint https://github.com/gaerae/awesome-algorithms
√ Linting

@sindresorhus
Copy link
Owner

sindresorhus commented Feb 27, 2019

I don't really see the point in including Korean things in the English version of the list. They can be included in the Korean translation only. This would make the list less noisy. Then you can drop the - English. postfix too.

@sindresorhus
Copy link
Owner

The descriptions in the Tools section make no sense. They should describe what the tool is/does.

@sindresorhus
Copy link
Owner

Descriptions should not be titleized. For example, Free and Paid Content. and PDF Content..

@sindresorhus
Copy link
Owner

The heading of your list should be Awesome Algorithms Education and the repo URL should be https://github.com/gaerae/awesome-algorithms-education.

@sindresorhus
Copy link
Owner

  • Includes a succinct description of the project/theme at the top of the readme. (Example)

This should succinctly explain what algorithms are.

@gaerae
Copy link
Contributor Author

gaerae commented Mar 10, 2019

Fixed the problem. However, URL can not be changed because it is open to the public. 😢

@sindresorhus
Copy link
Owner

However, URL can not be changed because it is open to the public.

Of course it can. GitHub handles the redirection automatically.

@gaerae
Copy link
Contributor Author

gaerae commented May 13, 2019

Awesome! But, github pages domain not redirection automatically.

@sindresorhus
Copy link
Owner

I really don't see the point of the website version. It's just a worse formatted version of the repo readme...

@gaerae
Copy link
Contributor Author

gaerae commented Jun 10, 2019

@sindresorhus sindresorhus merged commit 10e816c into sindresorhus:master Jun 15, 2019
@sindresorhus
Copy link
Owner

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants