Skip to content

Commit eeb3c88

Browse files
authored
Merge pull request #39 from munendrasn/update-contribution
update contributing.md with steps to fetch submodule
2 parents 6634379 + 4ece657 commit eeb3c88

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

CONTRIBUTING.md

+12-3
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ filename wisely at this will be _installation slug_ of you package.
2323
The file name must end with `.yaml`.
2424

2525
> A good starting point is either
26-
the [thymeleaf](_data/packages/thymeleaf.ymal) or the
27-
[solritas-responsewriter](_data/packages/solritas-responsewriter.ymal)
26+
the [thymeleaf](_data/packages/thymeleaf.yaml) or the
27+
[solritas-responsewriter](_data/packages/solritas-responsewriter.yaml)
2828
package.
2929

3030
#### 3. Edit package descriptor
@@ -53,7 +53,7 @@ package:
5353
# proxy all releases in your repository
5454
repo: https://raw.githubusercontent.com/erikhatcher/solritas/master/repo/repository.json
5555

56-
# deploy "collection" oder "cluster" wide
56+
# deploy "collection" or "cluster" wide
5757
#
5858
# See: https://lucene.apache.org/solr/guide/8_6/package-manager.html#deploy-command
5959
install: collection
@@ -118,6 +118,15 @@ script. If you're on a Mac, use [Homebrew](https://brew.sh)
118118
$ brew install jq yq bats-core
119119
```
120120

121+
##### 4.2 Install Git submodules
122+
123+
tests depend on [bats-support](https://github.com/ztombol/bats-support),
124+
and [bat-assert](https://github.com/ztombol/bats-assert)
125+
126+
```bash
127+
$ git submodule update --init --recursive
128+
```
129+
121130
#### 5. Create pull request
122131

123132
Create a pull request. Our Travis build server will check and build your

0 commit comments

Comments
 (0)