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

Update README.md #1118

Merged
merged 2 commits into from
Feb 29, 2024
Merged

Update README.md #1118

merged 2 commits into from
Feb 29, 2024

Conversation

sofusalbertsen
Copy link
Contributor

This series of labs will take you from "Hello Docker" to deploying a containerized web application to a server.

Quality Standards

Note that we can help you achieve those standards, just try your best and be brave.
We'll guide you to the best of our abilities.

To be on the list, it would be nice if entries adhere to these quality standards:

  • It should take less than 20 sec to find what is the project, how to install it and how to use it.
  • Generally useful to the community.
  • A project on GitHub with a well documented README.md file and plenty of examples is considered high quality.
  • Clearly stating if an entry is related to (Linux) containers and not to Docker. There is an awesome list for that.
  • Clearly stating "what is it" i.e. which category it belongs to.
  • Clearly stating "what is it for" i.e. mention a real problem it solves (even a small one). Make it clear for the next person.
  • If it is a WIP (work in progress, not safe for production), please mention it. (Remember the time before Docker 1.0 ? ;-) )
  • Always put the link to the GitHub project instead of the website!

To be on the list, the project must have:

  • How to setup/install the project
  • How to use the project (examples)

If your PR is not merged, we will tell you why so that you may be able to improve it.
But usually, we are pretty relaxed people, so just come and say hi, we'll figure something out together.

Rules for Pull Request

  • Each item should be limited to one link, no duplicates, no redirection (careful with http vs https!)
  • The link should be the name of the package or project or website
  • Description should be clear and concise (read it out loud to be sure)
  • Description should follow the link, on the same line
  • Entries are listed alphabetically, please respect the order
  • If you want to add more than one link, please don't do all PR on the exact same line, it usually results in conflicts and your PR cannot be automatically merged...

Please contribute links to packages/projects you have used or are familiar with. This will help ensure high-quality entries.

Your commit message will be a tweet so write a good commit message, keep that in mind :)

This series of labs will take you from "Hello Docker" to deploying a containerized web application to a server.
Copy link

welcome bot commented Feb 29, 2024

Thank you for contributing. Please check out our contributing guidelines and welcome!

@sofusalbertsen
Copy link
Contributor Author

I have tried to adhere to your guidelines, let me know if anything is missing.

Copy link
Collaborator

@mashb1t mashb1t left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@mashb1t mashb1t merged commit cde4b9a into veggiemonk:master Feb 29, 2024
5 checks passed
Copy link

welcome bot commented Feb 29, 2024

Congrats on merging your first pull request! Checkout the twitter account (https://twitter.com/awesome_docker) to see your PR :D

@sofusalbertsen sofusalbertsen deleted the patch-1 branch February 29, 2024 14:47
@sofusalbertsen
Copy link
Contributor Author

Thanks!

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.

2 participants