Skip to content

Commit 720de40

Browse files
committed
Update docs
1 parent ea62aaa commit 720de40

File tree

1 file changed

+22
-1
lines changed

1 file changed

+22
-1
lines changed

.github/CONTRIBUTING.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,16 @@ var Amadeus = require('amadeus');
4545

4646
### Releasing
4747

48-
To release, make sure to update the version number, submit all your changes, tag the release in Git, and run `npm publish`. This will be replaced in the future by a deploy through Travis CI.
48+
To make a new release, follow the following steps:
49+
50+
- [ ] Update the version in `package.json` using semver rules
51+
- [ ] Update the `CHANGELOG.md` with the new version
52+
- [ ] Push all changes and ensure all tests pass on Travis
53+
- [ ] Tag your release in git using `git --tag vX.X.X`
54+
- [ ] Push the new tag `git push --tags`
55+
- [ ] Update the [Releases](https://github.com/amadeus4dev/amadeus-node/releases) tab on GitHub with a new release for the tag, copying the description from the `CHANGELOG.md`
56+
57+
Travis will bow build the package and release it to NPM.
4958

5059
## How to contribute to the Amadeus Node Client Library
5160

@@ -74,3 +83,15 @@ To release, make sure to update the version number, submit all your changes, tag
7483
#### **Do you have questions about the source code?**
7584

7685
* Ask any question about how to use the library by [raising a new issue](https://github.com/amadeusdev/amadeus-node/issues/new).
86+
87+
88+
#### **Do you want to contribute to the documentation?**
89+
90+
Excellent, to get start developing this library ensure you have Node 6+ installed and clone the repository.
91+
92+
Then, you should be able to run the tests.
93+
94+
```sh
95+
npm install # ensure all dependencies are installed
96+
npm run docs:dev # watches for changes and updates docs
97+
```

0 commit comments

Comments
 (0)