Skip to content

Commit b825db9

Browse files
cbettacbetta
committed
Add other templates
1 parent 79f6392 commit b825db9

File tree

10 files changed

+293
-0
lines changed

10 files changed

+293
-0
lines changed

‎.github/CODE_OF_CONDUCT.md‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, gender identity and expression, level of experience,
9+
nationality, personal appearance, race, religion, or sexual identity and
10+
orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at [email protected]. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72+
73+
[homepage]: https://www.contributor-covenant.org
74+

‎.github/CONTRIBUTING.md‎

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
## Development and Testing
2+
3+
To run the project locally, clone the repository and install the dependencies.
4+
5+
```
6+
git clone https://github.com/amadeusdev/amadeus-java.git
7+
cd amadeus-java
8+
bundle
9+
```
10+
11+
Make sure you have Gradle installed as well.
12+
13+
### About Lombok
14+
15+
This library uses [Lombok](https://projectlombok.org/) for simplifying the code base. To use this in your editor, make sure to follow the instructions on their site.
16+
17+
For example, for InteliJ follow [these instructions](https://projectlombok.org/setup/intellij).
18+
19+
### Running tests
20+
21+
To run tests, simply run `./gradlew tests`.
22+
23+
We are trying to keep 100% coverage, so keep an eye on the `coverage` folder for an overview of the coverage.
24+
25+
### Building
26+
27+
To build the jar run `./gradlew clean build`.
28+
29+
### Using a library locally
30+
31+
To use a library locally as a dependency, simply link to this library in your Gradle project by path:
32+
33+
```js
34+
compile files('/path/to/libs/amadeus-java-1.0.0-SNAPSHOT.jar')
35+
```
36+
37+
### Releasing
38+
39+
To make a new release, follow the following steps:
40+
41+
- [ ] Update the version in `Amadeus.java` using semver rules
42+
- [ ] Update the `CHANGELOG.md` with the new version
43+
- [ ] Push all changes and ensure all tests pass on Travis
44+
- [ ] Tag your release in git using `git --tag vX.X.X`
45+
- [ ] Push the new tag `git push --tags`
46+
- [ ] Update the [Releases](https://github.com/amadeus4dev/amadeus-java/releases) tab on GitHub with a new release for the tag, copying the description from the `CHANGELOG.md`
47+
48+
Travis will bow build the gem and release it to RubyGems.
49+
50+
## How to contribute to the Amadeus Ruby Gem
51+
52+
#### **Did you find a bug?**
53+
54+
* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/amadeusdev/amadeus-ruby/issues).
55+
56+
* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/amadeusdev/amadeus-ruby/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring.
57+
58+
#### **Did you write a patch that fixes a bug?**
59+
60+
* Open a new GitHub pull request with the patch.
61+
62+
* Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.
63+
64+
#### **Do you intend to add a new feature or change an existing one?**
65+
66+
* Suggest your change [in a new issue](https://github.com/amadeusdev/amadeus-ruby/issues/new) and start writing code.
67+
68+
* Make sure your new code does not break any tests and include new tests.
69+
70+
* With good code comes good documentation. Try to copy the existing documentation and adapt it to your needs.
71+
72+
* Close the issue or mark it as inactive if you decide to discontinue working on the code.
73+
74+
#### **Do you have questions about the source code?**
75+
76+
* Ask any question about how to use the library by [raising a new issue](https://github.com/amadeusdev/amadeus-ruby/issues/new).
77+
78+
#### **Do you want to contribute to the documentation?**
79+
80+
Excellent, to get start developing this library ensure you have Java 7+ installed and clone the repository.
81+
82+
Then, you should be able to create the docs.
83+
84+
```sh
85+
./gradlew javadoc
86+
```

‎.github/ISSUE_TEMPLATE.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
## Description
2+
3+
[Describe the issue]
4+
5+
## Steps to Reproduce
6+
7+
1. [First step]
8+
2. [Second step]
9+
3. [and so on...]
10+
11+
__Expected Behavior:__ [What you expect to happen]
12+
13+
__Actual Behavior:__ [What actually happens]
14+
15+
__Stable Behavior?__ [What percentage of the time does it reproduce?]
16+
17+
## Versions
18+
19+
[What version of Ruby/Rubygems are you running? What Operating System are you on?]
20+
21+
## Checklist
22+
23+
Please make sure you checked the following:
24+
25+
* Are you running Ruby 2.2+?
26+
* Did you download the latest version of this gem?

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
Fixes #
2+
3+
## Changes for this pull request
4+
5+
## Checklist
6+
7+
Remove this if you have done all of these:
8+
9+
* Ensure all tests pass and linting
10+
* Add any changes to the README
11+
* Add any changes or new comments to SDK methods
12+
* Ensure this PR only changes what it is intended to change

‎.github/SUPPORT.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Amadeus Support
2+
3+
Our [developer support team](https://developer.amadeus.com/developers) is here to help you. You can find us on [Twitter](#), [StackOverflow](#), and [email](#).

‎.github/images/dependencies.svg‎

Lines changed: 1 addition & 0 deletions
Loading

‎.github/images/support.svg‎

Lines changed: 1 addition & 0 deletions
Loading

‎CHANGELOG.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Changelog

‎CODE_OF_CONDUCT.md‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, gender identity and expression, level of experience,
9+
nationality, personal appearance, race, religion, or sexual identity and
10+
orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at [email protected]. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at [http://contributor-covenant.org/version/1/4][version]
72+
73+
[homepage]: http://contributor-covenant.org
74+
[version]: http://contributor-covenant.org/version/1/4/

‎LICENSE‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
The MIT License (MIT)
2+
Copyright (c) 2017 Amadeus IT Group SA
3+
4+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
5+
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
6+
rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
7+
persons to whom the Software is furnished to do so, subject to the following conditions:
8+
9+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
10+
Software.
11+
12+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
13+
WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
14+
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
15+
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

0 commit comments

Comments
 (0)