Skip to content

Latest commit

 

History

History
55 lines (39 loc) · 2.68 KB

CONTRIBUTING.md

File metadata and controls

55 lines (39 loc) · 2.68 KB
Raw

Contributing to Xero-NetStandard

We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features
  • Becoming a maintainer

We Develop with Github

We use github to host code, to track issues and feature requests, as well as accept pull requests.

We Use OpenAPI Generator

The best way to propose changes to the codebase is to open an issue to discuss.

We are using OpenAPI Generator and our OpenAPI specs, to create and update our models and client classes. Improvements may require updates to our OAS or our customized mustache templates.

We welcome your feedback and will work with you to incorporate them. (via generated code or pull request):

Sometimes, a pull request is the best way to communicate a change.

  1. Fork the repo and create your branch from master.
  2. If you've added code that should be tested, add tests.
  3. If you've changed implementation, update the documentation.
  4. Ensure the test suite passes.
  5. Issue that pull request!

Any contributions you make will be under the MIT Software License

In short, when you submit code changes, your submissions are understood to be under the same MIT License that covers the project. Feel free to contact the maintainers if that's a concern.

Report bugs using Github's issues

We use GitHub issues to track public bugs. Report a bug by opening a new issue; it's that easy!

General Support inquires

Submit requests for support using this SDK or Xero's developer platform and APIs to our API Support team.

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.

Write bug reports with detail, background, and sample code

  • A quick summary and/or background
  • Steps to reproduce
    • Be specific!
    • Give sample code if you can.
  • What you expected would happen
  • What actually happens
  • Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)

Use a Consistent Coding Style

Attempt to stick to the C# coding conventions seen here: https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/inside-a-program/coding-conventions

License

By contributing, you agree that your contributions will be licensed under its MIT License.