Skip to content

Update contributing.md to point to correct repo #15

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jan 6, 2018
Merged

Update contributing.md to point to correct repo #15

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,13 @@ Todo: Provide a clearer vision for the project.

Good pull requests, such as patches, improvements, and new features, are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.

Please ask first if somebody else is already working on this or the core developers think your feature is in-scope for Create React App. Generally always have a related issue with discussions for whatever you are including.
Please ask first if somebody else is already working on this or the core developers think your feature is in-scope for Create TypeScript Package. Generally always have a related issue with discussions for whatever you are including.

Please also provide a test plan, i.e. specify how you verified that your addition works.

## Folder Structure of Create React App
## Folder Structure of Create TypeScript Package
`create-typescript-package` is a monorepo, meaning it is divided into independent sub-packages.<br>
These packages can be found in the [`packages/`](https://github.com/facebookincubator/create-typescript-package/tree/master/packages) directory.
These packages can be found in the [`packages/`](https://github.com/ncphillips/create-typescript-package/tree/master/packages) directory.

### Overview of directory structure
```
Expand All @@ -33,7 +33,7 @@ packages/
### Package Descriptions
#### [create-typescript-package](https://github.com/ncphillips/create-typescript-package/tree/master/packages/create-typescript-package)
The global CLI command code can be found in this directory, and shouldn't often be changed. It should run on Node 0.10+.
#### [react-scripts](https://github.com/ncphillips/create-typescript-package/tree/master/packages/react-scripts)
#### [type-scripts](https://github.com/ncphillips/create-typescript-package/tree/master/packages/type-scripts)
This package is the heart of the project, which contains the scripts for setting up the development server, building production builds, configuring all software used, etc.<br>

## Setting Up a Local Copy
Expand Down Expand Up @@ -64,4 +64,4 @@ cd my-app
7. Wait for a long time, and it will get published. Don’t worry that it’s stuck. In the end the publish script will prompt for versions before publishing the packages.
8. After publishing, create a GitHub Release with the same text as the changelog entry. See previous Releases for inspiration.

Make sure to test the released version! If you want to be extra careful, you can publish a prerelease by running `npm run publish -- --tag next` instead of `npm run publish`.
Make sure to test the released version! If you want to be extra careful, you can publish a prerelease by running `npm run publish -- --tag next` instead of `npm run publish`.