Skip to content

Commit ef8f917

Browse files
authored
Merge pull request #1 from XeroAPI/master
Update fork
2 parents e1c17a9 + 66fefb4 commit ef8f917

File tree

619 files changed

+247374
-7073
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

619 files changed

+247374
-7073
lines changed
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**SDK you're using (please complete the following information):**
11+
- Version [e.g. 2.3.10]
12+
13+
**Describe the bug**
14+
A clear and concise description of what the bug is.
15+
16+
**To Reproduce**
17+
Steps to reproduce the behavior:
18+
1. Go to '...'
19+
2. Click on '....'
20+
3. Scroll down to '....'
21+
4. See error
22+
23+
**Expected behavior**
24+
A clear and concise description of what you expected to happen.
25+
26+
**Screenshots**
27+
If applicable, add screenshots to help explain your problem.
28+
29+
**Additional context**
30+
Add any other context about the problem here.
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: enhancement
6+
assignees: SidneyAllen
7+
8+
---
9+
10+
**SDK you're using (please complete the following information):**
11+
- Version [e.g. 2.3.10]
12+
13+
**Is your feature request related to a problem? Please describe.**
14+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
15+
16+
**Describe the solution you'd like**
17+
A clear and concise description of what you want to happen.
18+
19+
**Describe alternatives you've considered**
20+
A clear and concise description of any alternative solutions or features you've considered.
21+
22+
**Additional context**
23+
Add any other context or screenshots about the feature request here.

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
/target/
2+
/src/main/resources/
23
.classpath
34
.project
45
.settings
@@ -137,3 +138,4 @@ nbbuild/
137138
dist/
138139
nbdist/
139140
.nb-gradle/
141+
*.log

CODE_OF_CONDUCT.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
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, sex characteristics, gender identity and expression,
9+
level of experience, education, socio-economic status, nationality, personal
10+
appearance, race, religion, or sexual identity and 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+
75+
For answers to common questions about this code of conduct, see
76+
https://www.contributor-covenant.org/faq

CONTRIBUTING.md

Lines changed: 113 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
# Contributing to Xero-Java
2+
We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
3+
:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:
4+
5+
We want to make contributing to this project as easy and transparent as possible, whether it's:
6+
7+
The following is a set of guidelines for contributing to Xero and its projects, which are hosted in the [XeroAPI Organization](https://github.com/XeroAPI) on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
8+
9+
### Table Of Contents
10+
[Code of Conduct](#code-of-conduct)
11+
12+
[I don't want to read this whole thing, I just have a question!!!](#i-dont-want-to-read-this-whole-thing-i-just-have-a-question)
13+
14+
[How Can I Contribute?](#how-can-i-contribute)
15+
* [Which version of SDK are you using?](#Which-version-of-the-SDK-are-you-using)
16+
* [Reporting Bugs](#reporting-bugs)
17+
* [Suggesting Enhancements](#suggesting-enhancements)
18+
* [Pull Requests](#pull-requests)
19+
20+
21+
## Code of Conduct
22+
Please note that this project is released with a [Contributor Code of Conduct](https://github.com/XeroAPI/Xero-Java/blob/oauth2/CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
23+
24+
## I don't want to read this whole thing I just have a question!!!
25+
26+
> **Note:** Please don't file an issue to ask a question. You'll get faster results by using the resources below.
27+
28+
We have an official [message board](https://community.xero.com/developer) where Xero API support and the community chimes in with helpful advice if you have questions.
29+
30+
* [API Documentation](https://developer.xero.com/documentation/)
31+
* [Xero FAQ](https://developer.xero.com/faq)
32+
* [Community, the official Xero message board](https://community.xero.com/developer)
33+
* [Stackoverflow - Xero related](https://stackoverflow.com/questions/tagged/xero-api?sort=Newest)
34+
* [Submit requests for support](https://developer.xero.com/contact-xero-developer-platform-support/) to our API Support team.
35+
36+
# How Can I Contribute?
37+
38+
You can contribute by reporting bugs, suggesting enhancements, improving documentation i.e. [README](https://github.com/XeroAPI/Xero-Java/blob/oauth2/README.md) or submitting a pull request.
39+
40+
41+
## Which version of the SDK are you using?
42+
43+
As of Sept 2019, support for oAuth 2 will be generally available for developers. During this transition period from oAuth 1.0a to oAuth 2, we will be supporting two versions of the SDK.
44+
45+
46+
* 2.x code resides in `master` and supports oAuth 1.0a
47+
* 3.x code resides in the `oauth2` branch and supports oAuth 2
48+
49+
Bugs and enhancements for version 3.x will be prioritized over 2.x.
50+
51+
## Reporting Bugs
52+
53+
Bugs are tracked as issues in this repository.
54+
55+
Before opening a new issue:
56+
* **check [the README](https://github.com/XeroAPI/Xero-Java/blob/oauth2/README.md)** to see if the behavior you observed might be expected and if configuration options are available to provide you with the desired behavior.
57+
58+
* **perform a cursory search** to see if there's [an existing issue](https://github.com/XeroAPI/Xero-Java/issues) covering your feedback. If there is one and the issue is still open, **add a :+1: reaction** on the issue to express interest in the issue being resolved. That will help the team gauge interest without the noise of comments which trigger notifications to all watchers. Comments should be used only if you have new and useful information to share.
59+
60+
### Write bug reports with detail, background, and sample code
61+
62+
- Which version of the SDK are you using?
63+
- A quick summary and/or background
64+
- Steps to reproduce
65+
- Be specific!
66+
- Give sample code if you can.
67+
- What you expected would happen
68+
- What actually happens
69+
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
70+
71+
## Suggesting Enhancements
72+
73+
When opening an issue for a feature request:
74+
* **use a clear and descriptive title** for the issue to identify the problem.
75+
* **include as many details as possible in the body**. Explain your use-case, the problems you're hitting and the solutions you'd like to see to address those problems.
76+
77+
## Pull requests
78+
79+
We welcome your feedback and pull requests. Be aware some code is generated and pull requests may not be the best solution - see below.
80+
81+
### We Use OpenAPI Generator
82+
The best way to propose changes to the codebase is to open an [issue](https://github.com/XeroAPI/Xero-Java/issues) and discuss with our team.
83+
84+
We are using [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) and [our OpenAPI specs](https://github.com/XeroAPI/Xero-OpenAPI), to create and update our models and client classes. Improvements may require updates to our OAS or our customized mustache templates instead of modifying via pull request.
85+
86+
### Submit a pull request
87+
88+
1. Fork and clone the repository
89+
1. Create a new branch: `git checkout -b my-branch-name`
90+
1. Make your change, add tests if needed
91+
1. Make sure the tests pass on your machine: `mvn test`
92+
1. Push to your fork and submit a pull request
93+
1. Pat your self on the back and wait for your pull request to be reviewed and merged.
94+
95+
Here are a few things you can do that will increase the likelihood of your pull request being accepted:
96+
97+
- Follow the [style guide](#style-guide).
98+
- Write tests.
99+
- Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
100+
- Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
101+
102+
### Style Guide
103+
104+
* 4 spaces for indentation rather than tabs
105+
106+
How to indent a Java source file in Eclipse:
107+
* Open the file in Eclipse's text editor.
108+
* Ctrl+A to select all text.
109+
* Ctrl+I to indent the text (or right click > Source > Indent).
110+
* Ctrl+S to save the file.
111+
112+
## License
113+
By contributing, you agree that your contributions will be licensed under its MIT License.

0 commit comments

Comments
 (0)