Skip to content

Commit

Permalink
docs(contribute): update CONTRIBUTING.md link (#20)
Browse files Browse the repository at this point in the history
* update git link in package.json
* update README
* fix internal repo issue tracking links

close #22
  • Loading branch information
yungcheng committed Jan 24, 2018
1 parent 0bf025a commit b105380
Show file tree
Hide file tree
Showing 8 changed files with 19 additions and 29 deletions.
10 changes: 5 additions & 5 deletions .github/PULL_REQUEST_TEMPLATE.md
Expand Up @@ -30,11 +30,11 @@ Please check if your PR fulfills the following requirements:

Supported commit types: build, chore, ci, docs, feat, fix, perf, refactor, revert, style, test.
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](CONTRIBUTING.md#commit).



#### Other information:

24 changes: 9 additions & 15 deletions CONTRIBUTING.md
Expand Up @@ -15,14 +15,10 @@ Please familiarize yourself with the [project philosophy][project-philosophy].
### 1) Download the repository

```bash
git clone git@git.soma.salesforce.com:raptor/raptor.git
git clone git@github.com:salesforce/lwc.git
```

### 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.

### 3) Install Dependencies
### 2) Install Dependencies

*We use [yarn](https://yarnpkg.com/) because it is significantly faster than npm for our use case. See this command [cheatsheet](https://yarnpkg.com/lang/en/docs/migrating-from-npm/).*

Expand All @@ -32,20 +28,20 @@ yarn install

If this fails with an error about *UNABLE_TO_GET_ISSUER_CERT_LOCALLY*, *Error: unable to get local issuer certificate*, or a registry communication issue then re-verify that step 2 was successful.

### 4) Start the server
### 3) Start the server

```bash
yarn start
```

### 5) View examples
### 4) View examples

Load the examples in a browser: [http://localhost:8080/](http://localhost:8080/)


## Building Raptor
## Building LWC

When using `yarn start`, raptor will build in dev-mode with a watcher, but if you wish to compile raptor in production mode, you can use the following command:
When using `yarn start`, lwc will build in dev-mode with a watcher, but if you wish to compile lwc in production mode, you can use the following command:

```bash
yarn run build
Expand All @@ -58,7 +54,7 @@ code review process delightful!

### types

Raptor relies on type annotataions heavily.
LWC relies on type annotataions heavily.

* Make sure your editor supports [typescript](https://www.typescriptlang.org/).

Expand Down Expand Up @@ -148,14 +144,12 @@ the ones related to the files you make changes to!
yarn test
```

More details testing in our [TESTING.md](https://git.soma.salesforce.com/raptor/raptor/tree/master/docs/TESTING.md) guide.

### Create a pull request

If you've never created a pull request before, follow [these
instructions][creating-a-pull-request].
Pull request title must be formatted according to [Commit Message Guidelines](#commit).
Pull request samples can be found [here](https://git.soma.salesforce.com/lwc/lwc/pulls)
Pull request samples can be found [here](https://github.com/salesforce/lwc/pulls)

### Update the pull request

Expand Down Expand Up @@ -197,7 +191,7 @@ to read on GitHub as well as in various git tools.

Footer should contain a [closing reference to an issue](https://help.github.com/articles/closing-issues-via-commit-messages/) if any.

Samples: (even more [samples](https://git.soma.salesforce.com/lwc/lwc/pulls))
Samples: (even more [samples](https://github.com/salesforce/lwc/pulls))

```
docs(changelog): update change log to beta.5
Expand Down
6 changes: 3 additions & 3 deletions README.md
@@ -1,6 +1,6 @@
# Raptor Engine Repository
# LWC Repository

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](CONTRIBUTING.md) or using Raptor.

## Getting Start

Expand All @@ -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](CONTRIBUTING.md) to set up your environment and start contributing.

## License

Expand Down
2 changes: 1 addition & 1 deletion package.json
Expand Up @@ -24,7 +24,7 @@
},
"repository": {
"type": "git",
"url": "https://git.soma.salesforce.com/lwc/lwc.git"
"url": "https://github.com/salesforce/lwc.git"
},
"bin": {
"lwc-compiler": "bin/lwc-compiler-cli.js"
Expand Down
1 change: 0 additions & 1 deletion packages/lwc-engine/src/framework/patch.ts
Expand Up @@ -20,7 +20,6 @@ export const patch = init([
// Attrs need to be applied to element before props
// IE11 will wipe out value on radio inputs if value
// is set before type=radio.
// See https://git.soma.salesforce.com/raptor/raptor/issues/791 for more
attrs,
props,
classes,
Expand Down
2 changes: 1 addition & 1 deletion packages/lwc-integration/src/shared/test-case.js
Expand Up @@ -18,7 +18,7 @@ export default class TestCase extends Element {
}
get issueHref() {
return `https://git.soma.salesforce.com/raptor/raptor/issues/${this.issueId}`;
return `https://github.com/salesforce/lwc/issues/${this.issueId}`;
}
get headerStyle() {
Expand Down
@@ -1,5 +1,4 @@
<template>
<!-- Regression: https://git.soma.salesforce.com/raptor/raptor/issues/627 -->
<slot name="secret-slot">
<p>Test slot content</p>
</slot>
Expand Down
2 changes: 0 additions & 2 deletions packages/proxy-compat/src/__tests__/object-test.ts
Expand Up @@ -11,7 +11,6 @@ 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
xit('should return correct keys from proxy', function () {
const proxy = new XProxy({
foo: 'bar'
Expand All @@ -35,7 +34,6 @@ 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
xit('should assign symbols correctly', function () {
const sym = Symbol();
const proxy = new XProxy({ foo: 'bar', [sym]: 1 }, {});
Expand Down

0 comments on commit b105380

Please sign in to comment.