Skip to content

Commit 51a72a0

Browse files
authored
Merge pull request #8 from emin93/add-contribution-guideline
added a contribution guideline
2 parents cb4fc02 + e9b8569 commit 51a72a0

File tree

2 files changed

+25
-2
lines changed

2 files changed

+25
-2
lines changed

CONTRIBUTING.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Contributing
2+
3+
Cool, I'm glad you decided to contribute to React Native Template TypeScript.
4+
5+
Don't worry, I won't bother you with thousands of rules. I want to make contributing to this project as easy and transparent as possible.
6+
7+
## Workflow
8+
9+
We use [GitHub Flow](https://guides.github.com/introduction/flow/), so all code changes happen through pull requests.
10+
11+
1. Fork the repository and create your branch from `master`.
12+
2. If you've changed the functionality, update the documentation.
13+
3. Issue that pull request! :tada:
14+
15+
## License
16+
17+
By contributing, you agree that your contributions will be licensed under the [MIT License](https://choosealicense.com/licenses/mit/).
18+
19+
## Code style
20+
21+
Currently there is no lint configuration, but you should try to stay consistent with the existing code.

setup.js

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,13 @@ const isYarnAvailable = () => {
2020
const packageManager = isYarnAvailable() ? 'yarn' : 'npm';
2121
const execOptions = { stdio: 'inherit' };
2222

23-
console.log('\n🔄 Please wait...\n');
23+
console.log('🔄 Please wait...\n');
2424

2525
packageJson.scripts.start = `${packageJson.scripts.start} --config ../../../../rn-cli.config.js`;
2626
packageJson.jest = Object.assign(packageJson.jest, jestConfig);
2727
writeFile('package.json', JSON.stringify(packageJson, null, 2));
2828

29-
console.log(`\n📦 Installing dependencies with ${packageManager}...\n`);
29+
console.log(`📦 Installing dependencies with ${packageManager}...\n`);
3030

3131
switch (packageManager) {
3232
case 'yarn':
@@ -43,6 +43,8 @@ deleteFile('devDependencies.json');
4343
deleteFile('jest.json');
4444
deleteFile('README.md');
4545
deleteFile('LICENSE');
46+
deleteFile('CODE_OF_CONDUCT.md');
47+
deleteFile('CONTRIBUTING.md');
4648
deleteFile('setup.js');
4749

4850
console.log(`\n✅ Setup completed! You can now start with: ${packageManager} start\n`);

0 commit comments

Comments
 (0)