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 Urban & Regional Planning #2013

Merged
merged 6 commits into from
Jun 5, 2021
Merged

Add Urban & Regional Planning #2013

merged 6 commits into from
Jun 5, 2021

Conversation

d-wasserman
Copy link
Contributor

@d-wasserman d-wasserman commented May 15, 2021

Add APA Technology Divisions GitHub Repo for Urban Planning.

https://github.com/APA-Technology-Division/urban-and-regional-planning-resources
Working Previous Link is here.

This list is sponsored by the APA Technology Division and is intended to catalog urban planning tools and resources.

We have an issue discussing compliance with awesome-list standards here.
APA-Technology-Division/urban-and-regional-planning-resources#14

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

We have reviewed there requirements for inclusion, and have made edits sufficient to pass awesome-lint checks. We needed to add a disable flag for our TOC (there was error with no clear direction to resolve), but are willing to work through that if that is determined to be necessary. Generally, we felt the awesome-lint process while difficult improved the quality of our repo.
Edit*
We are not going to rename our repo to awesome-urban-planning because of the existing of a training where this repo name is used, and there are concerns the name would not be inclusive from our membership.
We hope that the mission to create an index of knowledge resources is sufficient for compliance, but we are willing to discuss edits.

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

PRs reviewed

Contributions also have been made to awesome-gis and other lists to support the spirit of open-source.


  • 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 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.

Add APA Technology Divisions GitHub Repo for Urban Planning.
@iam-frankqiu
Copy link

The repo name of your list should be in lowercase slug format: awesome-planning-technology-resources.

@iam-frankqiu iam-frankqiu mentioned this pull request May 19, 2021
@d-wasserman
Copy link
Contributor Author

d-wasserman commented May 19, 2021

The maintainers of this repo have maintained that slugs saying awesome is recommended, but not a requirement. We would like to proceed with our current name.
We did recently close out an issue on our repo where we did a huge renovation to pass the awesome-lint tests. We are still working on it being perfect, but we are close. I think we have put forth a good faith effort to comply with the spirit of this resource collection.

@d-wasserman
Copy link
Contributor Author

unicorn

readme.md Outdated
@@ -671,6 +671,7 @@
- [Open Source Photography](https://github.com/ibaaj/awesome-OpenSourcePhotography#readme)
- [OpenGL](https://github.com/eug/awesome-opengl#readme) - Cross-platform API for rendering 2D and 3D graphics.
- [GraphQL](https://github.com/chentsulin/awesome-graphql#readme)
- [Urban Planning](https://github.com/APA-Technology-Division/planning-technology-resources#readme) - Resources & tools for urban planners & urbanists.
Copy link
Owner

Choose a reason for hiding this comment

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

The description here should succinctly describe what "urban planning" is, not what the list contains.

Copy link
Owner

Choose a reason for hiding this comment

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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Whew...succinctly encapsulate urban planning...tall order, but I will review and revise accordingly.

To clarify, the repo description must match what is in the awesome list? Or can they be just similar? I feel like the awesome list description should be shorter.

If your time is short, I will just revise for review.

Copy link
Owner

Choose a reason for hiding this comment

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

To clarify, the repo description must match what is in the awesome list? Or can they be just similar?

The one in the Awesome list should be succinct. The one in your list can be longer.

Update readme to less about contents, and more about what urban planning is.
@d-wasserman
Copy link
Contributor Author

Made edits to both locations. Mimic of language is done in both location (but the repo description is taking inspiration from the awesome-transit list).

@sindresorhus
Copy link
Owner

The title used here does not match the actual list title and repo name.

@d-wasserman
Copy link
Contributor Author

This pushes a discussion forward I need to rope in others for on ourside. We have discussed urban-and-regional-planning-resources. Want to get consensus before a repo name rename.

@d-wasserman d-wasserman changed the title Add Urban Planning Add Urban & Regional Planning Jun 1, 2021
@d-wasserman
Copy link
Contributor Author

Updates were made on the repo for this request. Please let us know any other issues to resolve.

readme.md Outdated Show resolved Hide resolved
Remove end space. Minor edit.

Co-authored-by: Sindre Sorhus <sindresorhus@gmail.com>
@sindresorhus sindresorhus merged commit 5a03b0f into sindresorhus:main Jun 5, 2021
@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