Skip to content

Commit 109a0fc

Browse files
committed
Code of conduct and contributing guidelines
Added Code of conduct and contributing guidelines to root.
1 parent 5ad8533 commit 109a0fc

File tree

2 files changed

+131
-0
lines changed

2 files changed

+131
-0
lines changed

CODE_OF_CONDUCT.md

+76
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

+55
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Contributing to Xero-NetStandard
2+
We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
3+
4+
- Reporting a bug
5+
- Discussing the current state of the code
6+
- Submitting a fix
7+
- Proposing new features
8+
- Becoming a maintainer
9+
10+
## We Develop with Github
11+
We use github to host code, to track issues and feature requests, as well as accept pull requests.
12+
13+
## We Use OpenAPI Generator
14+
The best way to propose changes to the codebase is to open an [issue](https://github.com/XeroAPI/Xero-Java/issues) to discuss.
15+
16+
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.
17+
18+
We welcome your feedback and will work with you to incorporate them. (via generated code or pull request):
19+
20+
Sometimes, a pull request is the best way to communicate a change.
21+
22+
1. Fork the repo and create your branch from `master`.
23+
2. If you've added code that should be tested, add tests.
24+
3. If you've changed implementation, update the documentation.
25+
4. Ensure the test suite passes.
26+
5. Issue that pull request!
27+
28+
## Any contributions you make will be under the MIT Software License
29+
In short, when you submit code changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if that's a concern.
30+
31+
## Report bugs using Github's [issues](https://github.com/XeroAPI/Xero-NetStandard/issues)
32+
We use GitHub issues to track public bugs. Report a bug by [opening a new issue](); it's that easy!
33+
34+
## General Support inquires
35+
[Submit requests for support](https://developer.xero.com/contact-xero-developer-platform-support/) using this SDK or Xero's developer platform and APIs to our API Support team.
36+
37+
Please don't open GitHub issues for general support - we will be closing these and directing you to submit via the developer platform support form.
38+
39+
## Write bug reports with detail, background, and sample code
40+
41+
- A quick summary and/or background
42+
- Steps to reproduce
43+
- Be specific!
44+
- Give sample code if you can.
45+
- What you expected would happen
46+
- What actually happens
47+
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
48+
49+
## Use a Consistent Coding Style
50+
Attempt to stick to the C# coding conventions seen here:
51+
https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/inside-a-program/coding-conventions
52+
53+
54+
## License
55+
By contributing, you agree that your contributions will be licensed under its MIT License.

0 commit comments

Comments
 (0)