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: .github/CONTRIBUTING.md
+22-1Lines changed: 22 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -45,7 +45,16 @@ var Amadeus = require('amadeus');
45
45
46
46
### Releasing
47
47
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.
49
58
50
59
## How to contribute to the Amadeus Node Client Library
51
60
@@ -74,3 +83,15 @@ To release, make sure to update the version number, submit all your changes, tag
74
83
#### **Do you have questions about the source code?**
75
84
76
85
* 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
0 commit comments