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.

Sign up for GitHub

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

Jump to bottom

Add Engineering Team Management #1887

Merged
merged 1 commit into from
Oct 29, 2020
Merged

Add Engineering Team Management #1887

merged 1 commit into from
Oct 29, 2020

Conversation

kdeldycke
Copy link
Contributor

https://github.com/kdeldycke/awesome-management

Why is this list awesome?

You wonder what it looks like to be a manager from the inside? You just started your first job as the leader of a team? You're stuck into the day-to-day operations of the job? You need to move up to the next level? This awesome list is written for you!

This body of work stands out from generic leadership and management literature, by providing uncompromising insights and practical advices to bootstrap your journey into the management career track, from a technical background.

This list provides a progression to help with the transition to management. From general to specifics. It starts with an overview of the role, then describes its requirements, its position relatives to others. Then we delves into the day-to-day tools of the trade, both organizational and behavioral. At last we discuss about some of the dark sides of the job.

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.

❗I read this PR template multiple times. Better yet: I contributed to refining it: 488c105

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.
    Sort of. I'm involved in the community by other means:
    ❗ I already contributed to this repository: https://github.com/sindresorhus/awesome/commits?author=kdeldycke
    ❗ I pushed code to awesome-lint to automate even more the work of reviewing lists: https://github.com/sindresorhus/awesome-lint/commits?author=kdeldycke
  • 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.
    ❗This repository has been active since January 2019: kdeldycke/awesome-engineering-team-management@6d161db
  • 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.
    ❗There is false positives with awesome-lint, which I reported and proposed a PR at: Fix matching of opening curly quote in description awesome-lint#127
  • 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.
    ❗I worked on this for 2 years, made 500+ commits, highly curated the list (we're far from a simple collection of links), and was involved into the community
  • 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=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, 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.

@kdeldycke
Copy link
Contributor Author

🦄

sindresorhus
sindresorhus reviewed Oct 25, 2020
View reviewed changes
readme.md Outdated Show resolved Hide resolved
@sindresorhus
Copy link
Owner

Run https://github.com/sindresorhus/awesome-lint and fix issues.

@sindresorhus
Copy link
Owner

I would remove the text title as the header image already contains that. Now it looks weird being duplicated.

@kdeldycke
Copy link
Contributor Author

Thanks @sindresorhus for the quick review!

  • I merged the simplification of the entry's description as you suggested at Add Engineering Team Management #1887 (comment)

  • awesome-lint reports several issues:

    ❯ awesome-lint --version
0.16.0

    ❯ awesome-lint ./readme.md
✖ Linting

  readme.md:987:3
  ✖     1:1    Missing main list heading                           remark-lint:awesome-heading
  ✖   133:176  List item description must start with valid casing  remark-lint:awesome-list-item
  ✖   205:108  List item description must start with valid casing  remark-lint:awesome-list-item
  ✖   217:115  List item description must start with valid casing  remark-lint:awesome-list-item
  ✖   221:98   List item description must start with valid casing  remark-lint:awesome-list-item
  ✖   223:178  List item description must start with valid casing  remark-lint:awesome-list-item
  ✖   307:104  List item description must start with valid casing  remark-lint:awesome-list-item
  ✖   343:151  List item description must start with valid casing  remark-lint:awesome-list-item
  ✖   357:147  List item description must start with valid casing  remark-lint:awesome-list-item
  ✖   413:57   List item description must start with valid casing  remark-lint:awesome-list-item
  ✖   423:360  List item description must start with valid casing  remark-lint:awesome-list-item
  ✖   437:82   List item description must start with valid casing  remark-lint:awesome-list-item
  ✖   601:65   List item description must start with valid casing  remark-lint:awesome-list-item
  ✖   777:124  List item description must start with valid casing  remark-lint:awesome-list-item
  ✖   949:163  List item description must start with valid casing  remark-lint:awesome-list-item
  ✖   965:145  List item description must start with valid casing  remark-lint:awesome-list-item
  ✖   987:3    https://danluu.com/wat/                             remark-lint:double-link
  ✖   997:105  List item description must start with valid casing  remark-lint:awesome-list-item
  ✖  1003:308  https://danluu.com/wat/#fn:P                        remark-lint:double-link

  19 errors

    Should we considers these issues as false-positive?

@wernerkrauss
Copy link
Contributor

You can tell awesome lint to ignore some rules, e.g. the missing header.

I also noticed, that your repository doesn't match your list name.

Shouldn't the contributing guidelines be in the project root? Why are they in the hidden folder ".github"?

@kdeldycke
Copy link
Contributor Author

You can tell awesome lint to ignore some rules, e.g. the missing header.

You're right, I forgot about that. Thanks for the reminder! Done in: kdeldycke/awesome-engineering-team-management@faf71a6

I also noticed, that your repository doesn't match your list name.

Yes I had a hard time deciding between the two.

  • Awesome Management as a title is too broad. I don't pretend to answer all management questions with my list, but only for the industry in which I practiced it. And for which I can bring some experience and critic. Management is diverse and is highly domain-dependent. If you can share most of the thinking framework and some concepts between activities, you do not have the same kind of rituals in say, a basketball team and a team of engineers. This awesome list focus on the later. That's why it is titled Awesome Engineering Team Management

  • I created the repository with awesome-management name 2 years ago without any plan. It's only later, with constant curation that it became a bigger project, focused on the Engineering Team part, as I grew with the job. I kept it that way as it was convenient and short. I have no issue renaming it awesome-engineering-team-management but I'm afraid it look too noisy. What's your final opinion? Maybe we can have @sindresorhus' comment here! 🙂

Shouldn't the contributing guidelines be in the project root? Why are they in the hidden folder ".github"?

That is allowed by GitHub itself to keep the root directory clean and tidy. And it is enforced by awesome-lint since: sindresorhus/awesome-lint#102

@sindresorhus sindresorhus merged commit a5a9fb1 into sindresorhus:main Oct 29, 2020
@sindresorhus
Copy link
Owner

Tweet: https://twitter.com/awesome__re/status/1321821945160192000

@sindresorhus
Copy link
Owner

I created the repository with awesome-management name 2 years ago without any plan. It's only later, with constant curation that it became a bigger project, focused on the Engineering Team part, as I grew with the job. I kept it that way as it was convenient and short. I have no issue renaming it awesome-engineering-team-management but I'm afraid it look too noisy. What's your final opinion? Maybe we can have @sindresorhus' comment here! 🙂

I would personally have gone with the verbose repo name, but I don't feel strongly about it.

@kdeldycke
Copy link
Contributor Author

Thanks a lot @sindresorhus for the merge! And long live to awesome project! ❤️ 🎉 🥳

@kdeldycke kdeldycke deleted the add-awesome-engineering-team-management branch October 29, 2020 14:34
@kdeldycke
Copy link
Contributor Author

I would personally have gone with the verbose repo name, but I don't feel strongly about it.

I can still change it if you like, as long as you don't mind another PR. Still have to check if GitHub properly handle redirects in the interim though.

@kdeldycke kdeldycke mentioned this pull request Oct 29, 2020
Merged
@kdeldycke
Copy link
Contributor Author

I just renamed the repository and the fix is available at: #1889

PS: I messed up the renaming and had to recreate the repository but no worries, everything is back to normal, I just lost my 300+ GitHub stars in the process 😅.

@wernerkrauss
Copy link
Contributor

OMG, I also renamed my repo to fit the renamed list and everything went fine. Didn't want you to loose your stars!

BTW: could you do me a favour and review #1879 ? Maybe I miss something or am totally blind

@kdeldycke
Copy link
Contributor Author

@wernerkrauss ahaah no need to worry for GitHub stars, they'll be back! ;)

@sindresorhus
Copy link
Owner

How is it possible to mess up renaming? Just curious.

@kdeldycke
Copy link
Contributor Author

kdeldycke commented Oct 29, 2020 •
edited

Once this branch got merged, I tried to clean up and was looking to remove the kdeldycke/awesome repository (i.e. my fork of sindresorhus/awesome). I mixed things up and remove kdeldycke/awesome-management instead... 🤦‍♂️

@sindresorhus
Copy link
Owner

Ok. Yeah, that sucks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sindresorhus sindresorhus sindresorhus left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@kdeldycke @sindresorhus @wernerkrauss