Skip to content

Commit 2a789a4

Browse files
committed
fix(update-readme): update Contributing.md and Changelog.md
1 parent 39fc802 commit 2a789a4

File tree

2 files changed

+16
-75
lines changed

2 files changed

+16
-75
lines changed

CHANGELOG.md

Lines changed: 7 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -3,31 +3,26 @@
33
All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
44

55
<a name="0.3.1"></a>
6-
## [0.3.1](https://github.com/Jam3/nyg-static-jam3/compare/v0.3.0...v0.3.1) (2019-01-17)
76

7+
## [0.3.1](https://github.com/Jam3/nyg-static-jam3/compare/v0.3.0...v0.3.1) (2019-01-17)
88

99
### Bug Fixes
1010

11-
* **gitignore:** add tmp folder back to gitignore ([5297044](https://github.com/Jam3/nyg-static-jam3/commit/5297044))
12-
13-
11+
- **gitignore:** add tmp folder back to gitignore ([5297044](https://github.com/Jam3/nyg-static-jam3/commit/5297044))
1412

1513
<a name="0.3.0"></a>
16-
# 0.3.0 (2019-01-17)
1714

15+
# 0.3.0 (2019-01-17)
1816

1917
### Bug Fixes
2018

21-
* **redux-route:** move setRoute to Pages, add stats.js for debugging, upgrade redux-dev-tools ([a6ff41a](https://github.com/Jam3/nyg-static-jam3/commit/a6ff41a))
22-
* **templates:** remove tmp folder files ([df1ac03](https://github.com/Jam3/nyg-static-jam3/commit/df1ac03))
23-
* **upgrade-redux:** upgrade redux ([21fecf4](https://github.com/Jam3/nyg-static-jam3/commit/21fecf4))
24-
19+
- **redux-route:** move setRoute to Pages, add stats.js for debugging, upgrade redux-dev-tools ([a6ff41a](https://github.com/Jam3/nyg-static-jam3/commit/a6ff41a))
20+
- **templates:** remove tmp folder files ([df1ac03](https://github.com/Jam3/nyg-static-jam3/commit/df1ac03))
21+
- **upgrade-redux:** upgrade redux ([21fecf4](https://github.com/Jam3/nyg-static-jam3/commit/21fecf4))
2522

2623
### Features
2724

28-
* **upgrade-react-static-version:** Upgrading react-static ([282b007](https://github.com/Jam3/nyg-static-jam3/commit/282b007))
29-
30-
25+
- **upgrade-react-static-version:** Upgrading react-static ([282b007](https://github.com/Jam3/nyg-static-jam3/commit/282b007))
3126

3227
<a name="0.2.0"></a>
3328

@@ -44,55 +39,3 @@ All notable changes to this project will be documented in this file. See [standa
4439
### Features
4540

4641
- **upgrade-react-static-version:** add initial template files ([7b1ba86](https://github.com/Jam3/nyg-static-jam3/commit/7b1ba86))
47-
48-
# Changelog
49-
50-
## Breakpoints and CSS fonts 1.0.0 (March 22, 2018)
51-
52-
Better way to handle breakpoints. Now you will configure the breakpoints that you want for the app and start using those breakpoints with a better semantic.
53-
Read more in https://github.com/eduardoboucas/include-media
54-
55-
Replaced font-family Calibri for Spectral. The new font is open source and was set as an example.
56-
57-
#### :nail_care: Enhancement
58-
59-
https://github.com/Jam3/nyg-jam3/pull/50
60-
61-
- Add include-media
62-
- [PR #50](https://github.com/Jam3/nyg-jam3/pull/50) Feature - CSS Font and Media query
63-
- Replace licensed font for open source font
64-
65-
- [PR #50](https://github.com/Jam3/nyg-jam3/pull/50) Feature - CSS Font and Media query
66-
67-
### Thanks
68-
69-
Thanks to @n0wak
70-
71-
---
72-
73-
## [TEMPLATE] 1.0.0 (March 22, 2018)
74-
75-
Description
76-
77-
#### :bug: Bug Fix
78-
79-
- Title
80-
- [#commit-number](link) Commit message
81-
82-
#### :nail_care: Enhancement
83-
84-
- Title
85-
- [#commit-number](link) Commit message
86-
87-
#### :memo: Documentation
88-
89-
- Title
90-
- [#commit-number](link) Commit message
91-
92-
#### :house: Internal
93-
94-
- Title
95-
96-
- [#commit-number](link) Commit message
97-
98-
### Thanks

CONTRIBUTING.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@ Following these guidelines helps to communicate the core ideas and the purpose o
66

77
## Core Ideas
88

9-
The generator structure is based on the same idea as [Create React App](https://github.com/facebook/create-react-app). We created a full boilerplate and we are using `react-scripts` to run our development server and create the build.
10-
11-
We are using [react-scripts](https://github.com/facebook/create-react-app/tree/next/packages/react-scripts) because it is fully supported by the community and includes the best and most up to date react standards. In order to customize it we decided **not** to [eject](https://github.com/facebook/create-react-app/blob/master/packages/react-scripts/template/README.md#npm-run-eject)) and we are using [react-app-rewired](https://github.com/timarney/react-app-rewired).
9+
The generator structure is based off the original [Create React App](https://github.com/facebook/create-react-app) and [React Static](https://github.com/nozzle/react-static) templates, familiarize yourselves with both repos to get a deeper understanding.
1210

1311
The purpose of this tool is to generate an opinionated template with the Jam3's standards and best practices. This template doesn't have configurations or prompts like [yeoman](http://yeoman.io/) or [nyg](https://www.npmjs.com/package/nyg)
1412

15-
We included in the project the most commonly used components and directory structure, it doesn't mean you need to use all of it and in that case our strategy is to delete those files instead of having a massive configuration file with many different cases, as this is usually hard to maintain. Probably in the future we decide to fork `react-scripts` but hasn't been decided.
13+
We included in the project the most commonly used components and directory structure, it doesn't mean you need to use all of it and in that case our strategy is to delete those files instead of having a massive configuration file with many different cases, as this is usually hard to maintain.
14+
15+
Feel free to include additional UI components via [Jam3 React UI](https://www.npmjs.com/package/@jam3/react-ui) as your project evolves and you can also generate components via the package.json dev scripts.
1616

1717
### Convention
1818

@@ -30,6 +30,8 @@ No rules are perfect. Sometimes we may introduce flags or configuration if we be
3030

3131
## Submitting a Pull Request
3232

33+
We use [Standard Version](https://github.com/conventional-changelog/standard-version) to help automate generating change logs, tags and release versioning, please ensure you follow [Conventional Commit Messages](https://conventionalcommits.org/) when making commits, as this is needed by Standard Version scripts to generate change logs based off the commits.
34+
3335
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.
3436

3537
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.
@@ -42,16 +44,12 @@ Don't forget to document in the repository your new change or patch. You should
4244

4345
## How to release a new version
4446

45-
After a PR is merged, you should:
46-
47-
1. Update the CHANGELOG.md file
48-
2. Bump the package.json version (major, minor, patch)
49-
3. Create a tag (release in github)
47+
Run `npm release` and Standard Version will handle the version bumping and change log updates.
5048

5149
## Folder Structure
5250

53-
* `templates`: It contains the files and folders needed to generate the app.
54-
* `test`: After running `npm test` it will copy the app into the `output` directory
51+
- `templates`: It contains the files and folders needed to generate the app.
52+
- `test`: After running `npm test` it will copy the app into the `output` directory
5553

5654
### Overview of root directory
5755

0 commit comments

Comments
 (0)