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 Scientific Writing #1700

Closed
wants to merge 6 commits into from
Closed

Add Scientific Writing #1700

wants to merge 6 commits into from

Conversation

maehr
Copy link
Contributor

@maehr maehr commented Feb 18, 2020

[Insert URL to the list here]

https://github.com/writing-resources/awesome-scientific-writing

[Explain what this list is about and why it should be included here]

Open source tools for painless academic writing.

This should be included, because academic writing is a hassle.

PRs:

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.
  • 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
    • 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 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.
  • 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.
  • 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=master&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 or text to the readme. GitHub already shows the license name 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.
  • 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.
  • 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.

readme.md Outdated Show resolved Hide resolved
@maehr maehr changed the title awesome-academic-writing added Add Academic Writing Feb 24, 2020
@ibnesayeed ibnesayeed mentioned this pull request Feb 25, 2020
readme.md Outdated Show resolved Hide resolved
fix #1700 (comment)

Co-Authored-By: Sawood Alam <[email protected]>
@ibnesayeed
Copy link
Contributor

Another PR guideline suggests that:

Your entry should be added at the bottom of the appropriate category.

However, you seem to have added it at the top to maintain sort order.

@thecoder8890
Copy link

Good to go

@tobiasvl
Copy link
Contributor

tobiasvl commented Mar 8, 2020

Looks good! But I think there's one last, horned guideline that hasn't been followed here yet?

There are many entries here that require specific knowledge to understand, but it's hard for me to tell whether anyone who is in academia would know the context (does everyone know what CSL stands for?). However, the following description seems vague and has a spelling error:

CSL Language and Editor - If you don not like my style, create your own.

maehr added a commit to maehr/awesome-academic-writing that referenced this pull request Mar 8, 2020
* add arabica

* Fix typo according to sindresorhus/awesome#1700 (comment)
@ashwinvis
Copy link

FYI, there is a similar list that I have been grooming for submission here: https://github.com/ashwinvis/awesome-scientific-writing

@maehr
Copy link
Contributor Author

maehr commented Mar 21, 2020

FYI, there is a similar list that I have been grooming for submission here: https://github.com/ashwinvis/awesome-scientific-writing

I like your list. We could merge our lists or further differentiate. My focus is clearly Pandoc Markdown.

@ashwinvis
Copy link

@maehr I agree with that proposal, and am willing to merge. You have some things that I left out. Shall I move mine to a common organization, so we can work together and make PRs to merge?

@maehr
Copy link
Contributor Author

maehr commented Mar 21, 2020

@maehr I agree with that proposal, and am willing to merge. You have some things that I left out. Shall I move mine to a common organization, so we can work together and make PRs to merge?

Yes, perfectly. I am looking forward to streamline the list together.

maehr added 2 commits April 30, 2020 00:32
* 'master' of github.com:sindresorhus/awesome:
  Add V (#1684)
  Add Waves (#1754)
  Use HTTPS links
  Add Database Tools (#1679)
  Add Game Remakes (#1745)
  Add Web Archiving (#1704)
  Add Material-UI (#1676)
  Create Testing section (#1731)
  Add Contexture (#1727)
  Add k6 (#1721)
  Add Awesome CLI (#1729)
  Meta tweaks
  Add StumbleUponAwesome (#1724)
  Add Yew (#1688)
  Add Coq (#1697)
  Add ESP (#1689)
@maehr maehr changed the title Add Academic Writing Add Scientific Writing Apr 29, 2020
@maehr
Copy link
Contributor Author

maehr commented Apr 29, 2020

@ashwinvis and I merged our lists. We are ready to go.

@maehr
Copy link
Contributor Author

maehr commented Apr 30, 2020

unicorn

@maehr maehr marked this pull request as draft May 6, 2020 21:58
@maehr maehr marked this pull request as ready for review May 6, 2020 21:59
@ashwinvis
Copy link

@ibnesayeed @thecoder8890 Do you approve the latest changes?

@ibnesayeed
Copy link
Contributor

LGTM!

@ashwinvis
Copy link

@sindresorhus, we have gone through the checklist in detail and got thumbs up from both reviewers.

@sindresorhus
Copy link
Owner

Consistent and correct naming. For example, Node.js, not NodeJS or node.js.

I see Markdown being written as markdown in at least one of the descriptions.

I also see some typos in the descriptions. Please go through all the descriptions and try to improve them.


Do not add the license name or text to the readme. GitHub already shows the license name at the top of the repo.

@sindresorhus
Copy link
Owner

I decided to rename master branch to main, and apparently that permanently closes all PRs. Ugh. Sorry about that. Can you reopen this PR targeting the main branch? Include a link to this PR in the new one, so we can quickly see what was discussed previously.

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