You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CHANGELOG.md
+7-64Lines changed: 7 additions & 64 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,31 +3,26 @@
3
3
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.
## 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
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+9-11Lines changed: 9 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,13 +6,13 @@ Following these guidelines helps to communicate the core ideas and the purpose o
6
6
7
7
## Core Ideas
8
8
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.
12
10
13
11
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)
14
12
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.
16
16
17
17
### Convention
18
18
@@ -30,6 +30,8 @@ No rules are perfect. Sometimes we may introduce flags or configuration if we be
30
30
31
31
## Submitting a Pull Request
32
32
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
+
33
35
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.
34
36
35
37
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
42
44
43
45
## How to release a new version
44
46
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.
50
48
51
49
## Folder Structure
52
50
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
0 commit comments