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 Digital Humanities #2155

Closed
wants to merge 0 commits into from
Closed

Add Digital Humanities #2155

wants to merge 0 commits into from

Conversation

maehr
Copy link
Contributor

@maehr maehr commented Jan 19, 2022

https://github.com/dh-tech/awesome-dhtools#readme

Digital Humanities is a vibrant and growing academic field. It relies on digital resources and services. The best of them are compiled in this list by DHTech, an ADHO Special Interest Group.

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

  • Don't waste my time. Do a good job, adhere to all the guidelines, and be responsive.
  • You have to review at least 2 other open pull requests.
    Try to prioritize unreviewed PRs, but you can also add more comments to reviewed PRs. Go through the below list when reviewing. This requirement is meant to help make the Awesome project self-sustaining. Comment here which PRs you reviewed. You're expected to put a good effort into this and to be thorough. Look at previous PR reviews for inspiration. Just commenting “looks good” or simply marking the pull request as approved does not count! You have to actually point out mistakes or improvement suggestions.
  • You have read and understood the instructions for creating a list.
  • This pull request has a title in the format Add Name of List.
    • Add Swift
    • Add Software Architecture
    • Update readme.md
    • Add Awesome Swift
    • Add swift
    • add Swift
    • Adding Swift
    • Added Swift
  • Your entry here should include a short description about the project/theme of the list. It should not describe the list itself. The first character should be uppercase and the description should end in a dot. It should be an objective description and not a tagline or marketing blurb.
    • - [iOS](…) - Mobile operating system for Apple phones and tablets.
    • - [Framer](…) - Prototyping interactive UI designs.
    • - [iOS](…) - Resources and tools for iOS development.
    • - [Framer](…)
    • - [Framer](…) - prototyping interactive UI designs
  • Your entry should be added at the bottom of the appropriate category.
  • The title of your entry should be title-cased and the URL to your list should end in #readme.
    • Example: - [Software Architecture](https://github.com/simskij/awesome-software-architecture#readme) - The discipline of designing and building software.
  • The suggested Awesome list complies with the below 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.
  • Don't open a Draft / WIP pull request while you work on the guidelines. A pull request should be 100% ready and should adhere to all the guidelines when you open it.
  • Run awesome-lint on your list and fix the reported issues. If there are false-positives or things that cannot/shouldn't be fixed, please report it.
  • The default branch should be named main, not master.
  • Includes a succinct description of the project/theme at the top of the readme. (Example)
    • Mobile operating system for Apple phones and tablets.
    • Prototyping interactive UI designs.
    • Resources and tools for iOS development.
    • Awesome Framer packages and tools.
  • It's the result of hard work and the best I could possibly produce.
    If you have not put in considerable effort into your list, your pull request will be immediately closed.
  • The repo name of your list should be in lowercase slug format: awesome-name-of-list.
    • awesome-swift
    • awesome-web-typography
    • awesome-Swift
    • AwesomeWebTypography
  • The heading title of your list should be in title case format: # Awesome Name of List.
    • # Awesome Swift
    • # Awesome Web Typography
    • # awesome-swift
    • # AwesomeSwift
  • Non-generated Markdown file in a GitHub repo.
  • The repo should have awesome-list & awesome as GitHub topics. I encourage you to add more relevant topics.
  • Not a duplicate. Please search for existing submissions.
  • Only has awesome items. Awesome lists are curations of the best, not everything.
  • Does not contain items that are unmaintained, has archived repo, deprecated, or missing docs. If you really need to include such items, they should be in a separate Markdown file.
  • Includes a project logo/illustration whenever possible.
    • Either centered, 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.
      • Can be placed centered if the list has a centered graphics header.
    • 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 nested lists, preferably none.
    • Must not feature Contributing or Footnotes sections.
  • Has an appropriate license.
    • We strongly recommend the CC0 license, but any Creative Commons license will work.
      • Tip: You can quickly add it to your repo by going to this URL: https://github.com/<user>/<repo>/community/license/new?branch=main&template=cc0-1.0 (replace <user> and <repo> accordingly).
    • A code license like MIT, BSD, Apache, GPL, etc, is not acceptable. Neither are WTFPL and Unlicense.
    • Place a file named license or LICENSE in the repo root with the license text.
    • Do not add the license name, text, or a Licence section to the readme. GitHub already shows the license name and link to the full text at the top of the repo.
    • To verify that you've read all the guidelines, please comment on your pull request with just the word unicorn.
  • Has contribution guidelines.
    • The file should be named contributing.md. Casing is up to you.
    • It can optionally be linked from the readme in a dedicated section titled Contributing, positioned at the top or bottom of the main content.
    • The section should not appear in the Table of Contents.
  • All non-important but necessary content (like extra copyright notices, hyperlinks to sources, pointers to expansive content, etc) should be grouped in a Footnotes section at the bottom of the readme. The section should not be present in the Table of Contents.
  • 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 use hard-wrapping.
  • Doesn't include a Travis badge.
    You can still use Travis for list linting, but the badge has no value in the readme.
  • Doesn't include an Inspired by awesome-foo or Inspired by the Awesome project kinda link at the top of the readme. The Awesome badge is enough.

Go to the top and read it again.

@sindresorhus
Copy link
Owner

Thanks for making an Awesome list! 🙌

It looks like you didn't read the guidelines closely enough. I noticed multiple things that are not followed. Try going through the list point for point to ensure you follow it. I spent a lot of time creating the guidelines so I wouldn't have to comment on common mistakes, and rather spend my time improving Awesome.

@sindresorhus
Copy link
Owner

Don't open a Draft / WIP pull request while you work on the guidelines. A pull request should be 100% ready and should adhere to all the guidelines when you open it.

@maehr maehr marked this pull request as ready for review January 19, 2022 14:42
@maehr
Copy link
Contributor Author

maehr commented Jan 19, 2022

PRs:
#2153
#2050

unicorn

@maehr maehr changed the title add DHTools Add DHTools Jan 19, 2022
@sindresorhus sindresorhus force-pushed the main branch 3 times, most recently from c9f7039 to 4b3a8e2 Compare January 23, 2022 08:35
@riderx riderx mentioned this pull request Jan 23, 2022
@riderx
Copy link
Contributor

riderx commented Jan 23, 2022

@maehr thanks for the work !
One of your item in your list doesn't have description : YouTube Metadata
Almost all items in DH Centers need it too.
Same for Twitter you can get the twitter bio, it can help to understand what this account is about.

Your website is a good addition ! https://dh-tech.github.io/awesome-dhtools/

@eozer
Copy link
Contributor

eozer commented Mar 7, 2022

Yes I agree most of @riderx 's points. They are still valid points as of today, i.e, YouTube Metadata item, first 7 DH Centers section items, and Twitter section. Moreover I also saw DHCH, make sure to add a description over there too.

I think you need to add also Contributing section to the end of your README.md.

@eozer eozer mentioned this pull request Mar 7, 2022
maehr added a commit to dh-tech/awesome-digital-humanities that referenced this pull request Mar 8, 2022
maehr added a commit to dh-tech/awesome-digital-humanities that referenced this pull request Mar 10, 2022
@maehr
Copy link
Contributor Author

maehr commented Mar 10, 2022

I think you need to add also Contributing section to the end of your README.md.

Such a section is optional. We have decided to leave it with the file CONTRIBUTING.md.

@eozer
Copy link
Contributor

eozer commented Mar 15, 2022

@maehr, thanks for the correction. I have probably confused with awesome-lint error for Contributing section must not be in table of contents.

@maehr
Copy link
Contributor Author

maehr commented Apr 1, 2022

unicorn

@sindresorhus sindresorhus force-pushed the main branch 2 times, most recently from 0fdf977 to ec33c66 Compare May 14, 2022 09:40
@sindresorhus
Copy link
Owner

The list should be named Awesome Digital Humanities (repo too).

@sindresorhus
Copy link
Owner

Your entry here should include a short description about the project/theme of the list. It should not describe the list itself. The first character should be uppercase and the description should end in a dot. It should be an objective description and not a tagline or marketing blurb.

@maehr maehr changed the title Add DHTools Add Digital Humanities Jun 14, 2022
Copy link
Contributor

@benjaminsehl benjaminsehl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You're supposed to add your item to the bottom of the list in your category — but otherwise it looks good.

@maehr
Copy link
Contributor Author

maehr commented Jun 30, 2022

Unicorn

@rscircus
Copy link
Contributor

rscircus commented Sep 19, 2022

@sindresorhus - does the top category make sense:

image

Wouldn't it make more sense to split this up? 'Higher Education' can be a category for quite many things in this awesome list of awesome lists... I'll suggest sth.

Edit: Created this PR on the suggestion above: #2385.

@rscircus
Copy link
Contributor

@maehr it was merged meanwhile. :)

@maehr
Copy link
Contributor Author

maehr commented Sep 23, 2022

@rscircus thanks a bunch

@maehr
Copy link
Contributor Author

maehr commented Sep 23, 2022

@rscircus I am very sorry, but I am not able to find Digital Humanities in the list. (It is a different list from Digital History which I am also maintaining.)

BTW: I propose to change the heading from Health and Social Science to Health, Humanities and Social Science.

@rscircus
Copy link
Contributor

rscircus commented Sep 23, 2022 via email

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.

6 participants