docs(contribute): update CONTRIBUTING.md link #20
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
Benchmark comparisonBase commit:
|
trevor-bliss
approved these changes
Jan 22, 2018
Closed
Benchmark comparisonBase commit:
|
|
I like how updating docs and links make benchmark worse 💩 |
pmdartus
requested changes
Jan 23, 2018
README.md
Outdated
|
|
||
| This repository contains the source code for the Raptor Engine. Additionaly, it contains examples, documentation, meeting notes and discussion notes for developers [contributing](https://git.soma.salesforce.com/raptor/raptor/tree/master/CONTRIBUTING.md) or using Raptor. | ||
| This repository contains the source code for the LWC Engine and Compiler. Additionaly, it contains examples, documentation, meeting notes and discussion notes for developers [contributing](https://github.com/salesforce/lwc/blob/master/CONTRIBUTING.md) or using Raptor. |
There was a problem hiding this comment.
Use relative link instead of absolute: https://help.github.com/articles/about-readmes/#relative-links-and-image-paths-in-readme-files
README.md
Outdated
| @@ -12,7 +12,7 @@ This project is been developed by the Raptor Team in collaboration with Aura Tea | |||
|
|
|||
| ## Contributing | |||
|
|
|||
| Read our [contributing documentation](https://git.soma.salesforce.com/raptor/raptor/tree/master/CONTRIBUTING.md) to set up your environment and start contributing. | |||
| Read our [contributing documentation](https://github.com/salesforce/lwc/blob/master/CONTRIBUTING.md) to set up your environment and start contributing. | |||
There was a problem hiding this comment.
Use relative link instead of absolute: https://help.github.com/articles/about-readmes/#relative-links-and-image-paths-in-readme-files
CONTRIBUTING.md
Outdated
| ``` | ||
|
|
||
| ### 2) Setup npm/yarn to use Nexus repositories | ||
|
|
||
| Nexus provides a public caching proxy and a private repository which hosts several dependent raptor modules. Follow the instructions at [https://sfdc.co/npm-nexus](https://sfdc.co/npm-nexus) to setup access to the Nexus npm registry. | ||
| Nexus provides a public caching proxy and a private repository which hosts several dependent lwc modules. Follow the instructions at [https://sfdc.co/npm-nexus](https://sfdc.co/npm-nexus) to setup access to the Nexus npm registry. |
There was a problem hiding this comment.
We don't need Nexus anymore since the packages are published on an open registry.
.github/PULL_REQUEST_TEMPLATE.md
Outdated
| @@ -32,7 +32,7 @@ Please check if your PR fulfills the following requirements: | |||
| Supported scope: The scope should be the name of the npm package affected (engine, compiler, wire-service, etc.) | |||
|
|
|||
|
|
|||
| - More details on LWC semantic commit can be found [here](https://git.soma.salesforce.com/lwc/lwc/blob/master/CONTRIBUTING.md#commit). | |||
| - More details on LWC semantic commit can be found [here](https://github.com/salesforce/lwc/blob/master/CONTRIBUTING.md#commit). | |||
There was a problem hiding this comment.
Use relative link instead of absolute: https://help.github.com/articles/about-readmes/#relative-links-and-image-paths-in-readme-files
| @@ -11,7 +11,7 @@ describe('ECMA Object', function () { | |||
| // We do not patch Object.getOwnPropertySymbols because | |||
| // it is patched by the Symbol polyfill later on | |||
| // in the code. As a result, this test will not work in node. | |||
| // See https://git.soma.salesforce.com/raptor/raptor/issues/833 | |||
| // See lwc(internal) #833 | |||
There was a problem hiding this comment.
As discussed in #22 (comment), the internal repo will maybe be deleted one day. It would be nice to delete all the links to the internal repo.
yungcheng
force-pushed
the
vince/fix-pr-template-link
branch
from
a11464f
to
d246311
Compare
Benchmark comparisonBase commit:
|
yungcheng
force-pushed
the
vince/fix-pr-template-link
branch
from
d246311
to
4a44111
Compare
Benchmark comparisonBase commit:
|
pmdartus
approved these changes
Jan 24, 2018
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.
PR Checklist
What kind of change does this PR introduce? (add 'x' - [x])
Does this PR introduce a breaking change? (check one)
If yes, please describe the impact and migration path for existing applications:
Please check if your PR fulfills the following requirements:
The PR fulfills these requirements:
Tests for the changes have been added (for bug fixes / features)
Both unit and integration tests pass
Docs have been added / updated (for bug fixes / features)
The PR title follows conventional commit format:
commit-type(optional scope): commit description.More details on LWC semantic commit can be found here.
Other information: