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: CONTRIBUTING.md
+12-16Lines changed: 12 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,23 +6,22 @@ Please don't open issues for security issues. Instead, file a report at https://
6
6
7
7
## Reporting Issues
8
8
9
-
Please see our [FAQ](https://github.com/wycats/handlebars.js/blob/master/FAQ.md) for common issues that people run into.
9
+
Please see our [FAQ](https://github.com/handlebars-lang/handlebars.js/blob/master/FAQ.md) for common issues that people run into.
10
10
11
11
Should you run into other issues with the project, please don't hesitate to let us know by filing an [issue][issue]!
12
12
13
13
In general we are going to ask for an **example** of the problem failing, which can be as simple as a jsfiddle/jsbin/etc. We've put together a jsfiddle **[template][jsfiddle]** to ease this. (We will keep this link up to date as new releases occur, so feel free to check back here).
14
14
15
15
Pull requests containing only failing tests demonstrating the issue are welcomed and this also helps ensure that your issue won't regress in the future once it's fixed.
16
16
17
-
Documentation issues on the handlebarsjs.com site should be reported on [handlebars-site](https://github.com/wycats/handlebars-site).
17
+
Documentation issues on the [handlebarsjs.com](https://handlebarsjs.com) site should be reported on [handlebars-lang/docs](https://github.com/handlebars-lang/docs).
18
18
19
19
## Branches
20
20
21
21
- The branch `4.x` contains the currently released version. Bugfixes should be made in this branch.
22
22
- The branch `master` contains the next version. A release date is not yet specified. Maintainers
23
23
should merge the branch `4.x` into the master branch regularly.
24
-
25
-
* The branch `3.x` comtains the legacy version `3.x`. Bugfixes are applied seperately (if needed). The branch will not
24
+
- The branch `3.x` contains the legacy version `3.x`. Bugfixes are applied separately (if needed). The branch will not
26
25
be merged with any of the other branches.
27
26
28
27
## Pull Requests
@@ -56,7 +55,7 @@ You can also run our set of benchmarks with `grunt bench`.
56
55
The `grunt dev` implements watching for tests and allows for in browser testing at `http://localhost:9999/spec/`.
57
56
58
57
If you notice any problems, please report them to the GitHub issue tracker at
@@ -87,38 +86,35 @@ We do linting and formatting in two phases:
87
86
88
87
- Committed files are linted and formatted in a pre-commit hook. In this stage eslint-errors are forbidden,
89
88
while warnings are allowed.
90
-
- The travis-ci job also lints all files and checks if they are formatted correctly. In this stage, warnings
89
+
- The GitHub CI job also lints all files and checks if they are formatted correctly. In this stage, warnings
91
90
are forbidden.
92
91
93
-
You can use the following scripts to make sure that the travis-job does not fail:
92
+
You can use the following scripts to make sure that the CI job does not fail:
94
93
95
94
-**npm run lint** will run `eslint` and fail on warnings
96
95
-**npm run format** will run `prettier` on all files
97
-
-**npm run check-before-pull-request** will perform all most checks that travis does in its build-job, excluding the "integration-test".
96
+
-**npm run check-before-pull-request** will perform all most checks that our CI job does in its build-job, excluding the "integration-test".
98
97
-**npm run integration-test** will run integration tests (using old NodeJS versions and integrations with webpack, babel and so on)
99
98
These tests only work on a Linux-machine with `nvm` installed (for running tests in multiple versions of NodeJS).
100
99
101
100
## Releasing the latest version
102
101
103
102
Before attempting the release Handlebars, please make sure that you have the following authorizations:
104
103
105
-
- Push-access to `wycats/handlebars.js`
104
+
- Push-access to `handlebars-lang/handlebars.js`
106
105
- Publishing rights on npmjs.com for the `handlebars` package
107
106
- Publishing rights on gemfury for the `handlebars-source` package
108
107
- Push-access to the repo for legacy package managers: `components/handlebars`
109
108
- Push-access to the production-repo of the handlebars site: `handlebars-lang/handlebarsjs.com-github-pages`
110
109
111
110
_When releasing a previous version of Handlebars, please look into the CONTRIBUNG.md in the corresponding branch._
112
111
113
-
Handlebars utilizes the [release yeoman generator][generator-release] to perform most release tasks.
114
-
115
112
A full release may be completed with the following:
116
113
117
114
```
118
115
npm ci
119
-
yo release
116
+
npx grunt
120
117
npm publish
121
-
yo release:publish components handlebars.js dist/components/
122
118
123
119
cd dist/components/
124
120
gem build handlebars-source.gemspec
@@ -135,13 +131,13 @@ in those places still point to the latest version
135
131
136
132
When everything is OK, the **handlebars site** needs to be updated.
137
133
138
-
Go to the master branch of the repo [handlebars-lang/handlebarsjs.com-github-pages](https://github.com/handlebars-lang/handlebarsjs.com-github-pages/tree/master)
134
+
Go to the master branch of the repo [handlebars-lang/docs](https://github.com/handlebars-lang/docs/tree/master)
139
135
and make a minimal change to the README. This will invoke a github-action that redeploys
140
136
the site, fetching the latest version-number from the npm-registry.
141
137
(note that the default-branch of this repo is not the master and regular changes are done
Copy file name to clipboardExpand all lines: FAQ.md
+5-3Lines changed: 5 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,11 +2,11 @@
2
2
3
3
## How can I file a bug report:
4
4
5
-
See our guidelines on [reporting issues](https://github.com/wycats/handlebars.js/blob/master/CONTRIBUTING.md#reporting-issues).
5
+
See our guidelines on [reporting issues](https://github.com/handlebars-lang/handlebars.js/blob/master/CONTRIBUTING.md#reporting-issues).
6
6
7
7
## Why isn't my Mustache template working?
8
8
9
-
Handlebars deviates from Mustache slightly on a few behaviors. These variations are documented in our [readme](https://github.com/wycats/handlebars.js#differences-between-handlebarsjs-and-mustache).
9
+
Handlebars deviates from Mustache slightly on a few behaviors. These variations are documented in our [readme](https://github.com/handlebars-lang/handlebars.js#differences-between-handlebarsjs-and-mustache).
10
10
11
11
## Why is it slower when compiling?
12
12
@@ -36,16 +36,18 @@
36
36
```sh
37
37
handlebars --version
38
38
```
39
+
39
40
If using the integrated precompiler and
40
41
41
42
```javascript
42
43
console.log(Handlebars.VERSION);
43
44
```
45
+
44
46
On the client side.
45
47
46
48
We include the built client libraries in the npm package for those who want to be certain that they are using the same client libraries as the compiler.
47
49
48
-
Should these match, please file an issue with us, per our [issue filing guidelines](https://github.com/wycats/handlebars.js/blob/master/CONTRIBUTING.md#reporting-issues).
50
+
Should these match, please file an issue with us, per our [issue filing guidelines](https://github.com/handlebars-lang/handlebars.js/blob/master/CONTRIBUTING.md#reporting-issues).
49
51
50
52
## How do I load the runtime library when using AMD?
0 commit comments