Updating README-TEMPLATE.md to contain 'Contributing' section #368
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
adrianhall
reviewed
May 16, 2019
| @@ -91,6 +91,9 @@ If the package or a related package supports it, include tips for logging or ena | |||
| * If appropriate, point users to other packages that might be useful. | |||
| * If you think there's a good chance that developers might stumble across your package in error (because they're searching for specific functionality and mistakenly think the package provides that functionality), point them to the packages they might be looking for. | |||
|
|
|||
| ## Contributing | |||
| Provide guidance for contributing to the client library. | |||
There was a problem hiding this comment.
Should this not just be a link to CONTRIBUTING.md which is required by the Microsoft OSS rules?
There was a problem hiding this comment.
Agreed. OK to have the Contributing section, but would be good to link to the file rather than copy-pasting.
KrzysztofCwalina
added a commit
that referenced
this pull request
Jun 13, 2019
* ready for review * TypeScript guidelines minor fixes/updates (#404) * mark usage of @azure/core-configuration as a TODO * add ts-package-json-module and ts-error-handling ids * change ts-use-typescript from Should to Must * change 'sourceMaps' (typo) to 'sourceMap' * change monorepo link to JS-specific repo, not the general Azure SDK repo * [General] split terminology and definitions (#405) Nice addition! * [General] Long-running Operations (#370) * Clean up PR * Updates for Adrian's review * Update LRO.mdk (#409) When included in the generated HTML output, the header is one level too few. Adding an extra `#` gets it into the correct level in the TOC (in my Java spec). * Updating README-TEMPLATE.md to contain 'Contributing' section (#368) * README-TEMPLATE contributing section update. (#411) * Updating README-TEMPLATE.md to contain 'Contributing' section * updating readme-template contributing section * review feedback * more updates based on feedback
bterlson
pushed a commit
to bterlson/azure-sdk
that referenced
this pull request
Apr 16, 2020
bterlson
pushed a commit
to bterlson/azure-sdk
that referenced
this pull request
Apr 16, 2020
* ready for review * TypeScript guidelines minor fixes/updates (Azure#404) * mark usage of @azure/core-configuration as a TODO * add ts-package-json-module and ts-error-handling ids * change ts-use-typescript from Should to Must * change 'sourceMaps' (typo) to 'sourceMap' * change monorepo link to JS-specific repo, not the general Azure SDK repo * [General] split terminology and definitions (Azure#405) Nice addition! * [General] Long-running Operations (Azure#370) * Clean up PR * Updates for Adrian's review * Update LRO.mdk (Azure#409) When included in the generated HTML output, the header is one level too few. Adding an extra `#` gets it into the correct level in the TOC (in my Java spec). * Updating README-TEMPLATE.md to contain 'Contributing' section (Azure#368) * README-TEMPLATE contributing section update. (Azure#411) * Updating README-TEMPLATE.md to contain 'Contributing' section * updating readme-template contributing section * review feedback * more updates based on feedback
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.
The CI process which verifies README.md for client libraries now requires the 'Contributing' section. This changes adds this section to the README-TEMPLATE.md