Compliance to awesome repository requirements #38
+190
−45
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
glours
requested review from
aiordache and
chris-crone
and removed request for
aiordache
chris-crone
requested changes
Mar 26, 2020
CONTRIBUTING.md
Outdated
| samples that can be easily deployed with [Docker Compose](https://github.com/docker/compose). | ||
|
|
||
| ## Missing a kind of application? | ||
| You can request a new example of application by submitting an issue to our GitHub Repository. |
There was a problem hiding this comment.
nit: missing \n after heading
There was a problem hiding this comment.
Suggested change
| You can request a new example of application by submitting an issue to our GitHub Repository. | |
| You can request a new example of an application by submitting an issue to our GitHub repository. |
CONTRIBUTING.md
Outdated
|
|
||
| ## Missing a kind of application? | ||
| You can request a new example of application by submitting an issue to our GitHub Repository. | ||
| If you would like to implement a new application sample, please submit an issue with a proposal first, |
There was a problem hiding this comment.
Suggested change
| If you would like to implement a new application sample, please submit an issue with a proposal first, | |
| If you would like to submit a new application example, please start by submitting a proposal as an issue. |
CONTRIBUTING.md
Outdated
| You can request a new example of application by submitting an issue to our GitHub Repository. | ||
| If you would like to implement a new application sample, please submit an issue with a proposal first, | ||
| to be sure that we can use it. | ||
| Then we'll consult the community to know what can be the most valuable application with this technology/language/framework... |
There was a problem hiding this comment.
Suggested change
| Then we'll consult the community to know what can be the most valuable application with this technology/language/framework... | |
| The maintainers will then use this issue to discuss what the the most valuable example for the application, technology, language, or framework would be. |
CONTRIBUTING.md
Outdated
| to be sure that we can use it. | ||
| Then we'll consult the community to know what can be the most valuable application with this technology/language/framework... | ||
|
|
||
| After the choice made, you can submit your pull request following the choice of the community without forgetting to add : |
There was a problem hiding this comment.
Suggested change
| After the choice made, you can submit your pull request following the choice of the community without forgetting to add : | |
| After the choice has been made, you can submit your a pull request not forgetting to: |
CONTRIBUTING.md
Outdated
| Then we'll consult the community to know what can be the most valuable application with this technology/language/framework... | ||
|
|
||
| After the choice made, you can submit your pull request following the choice of the community without forgetting to add : | ||
| - a local README.md to describe the application and explain how to run/use the sample. |
There was a problem hiding this comment.
Suggested change
| - a local README.md to describe the application and explain how to run/use the sample. | |
| - include an example README.md to describe the application and explain how to run/use the sample |
CONTRIBUTING.md
Outdated
| The goal of the Awesome Compose is to provide a curated list of application | ||
| samples that can be easily deployed with [Docker Compose](https://github.com/docker/compose). | ||
|
|
||
| ## Missing a kind of application? |
There was a problem hiding this comment.
Suggested change
| ## Missing a kind of application? | |
| ## Missing an example? |
CONTRIBUTING.md
Outdated
| - a local README.md to describe the application and explain how to run/use the sample. | ||
| - edit the global README.md to add your sample in the repository main list. | ||
|
|
||
| ## Update a existing sample |
There was a problem hiding this comment.
We can actually remove this
CONTRIBUTING.md
Outdated
Comment on lines
25
to
38
| To help maintainers understand what user or developer problem needs to be | ||
| solved, the first step to a contribution is usually submitting an issue. A well | ||
| written issue is one that clearly outlines the developer or user problem that | ||
| needs to be solved along with a list of requirements for resolution of the | ||
| problem. If there are multiple possible solutions to the problem, these can be | ||
| outlined in the issue. Once consensus is reached on how to resolve the issue, a | ||
| pull request can be created. | ||
|
|
||
| Pull requests that propose minor changes or improvements may be submitted | ||
| without an associated issue or discussion. | ||
|
|
||
| For large or high impact changes, contributors can reach out to maintainers | ||
| before starting work. This will ensure that contributors and maintainers are | ||
| aligned and increase the chance that the change is accepted. |
There was a problem hiding this comment.
I think you can remove this as it's more targeted at code/specs
glours
force-pushed
the
awesome_compliance
branch
from
d45e3d8 to
30178cd
Compare
glours
force-pushed
the
awesome_compliance
branch
from
30178cd to
af836b2
Compare
chris-crone
requested changes
Mar 27, 2020
There was a problem hiding this comment.
Minor changes after seeing it all together. Thanks @glours!
CONTRIBUTING.md
Outdated
|
|
||
| Before submitting a new application, check if there isn't already application sample matching your need. | ||
|
|
||
| If there is one, consider to update it instead of create a new one. |
There was a problem hiding this comment.
nit:
Suggested change
| If there is one, consider to update it instead of create a new one. | |
| If there is one, consider updating it instead of creating a new one. |
CONTRIBUTING.md
Outdated
| The maintainers will then use this issue to discuss what the the most valuable example for the application, | ||
| technology, language, or framework would be. | ||
|
|
||
| After the choice has been made, you can submit your a pull request not forgetting to: |
There was a problem hiding this comment.
Suggested change
| After the choice has been made, you can submit your a pull request not forgetting to: | |
| After the choice has been made, you can submit a pull request with the example remembering to: |
Signed-off-by: Guillaume Lours <guillaume.lours@docker.com>
glours
force-pushed
the
awesome_compliance
branch
from
af836b2 to
7fcb573
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add
Fix
README.mdto be compliant with awesome repositorySigned-off-by: Guillaume Lours guillaume.lours@docker.com