Skip to content

Open Data Contract Standard

Executive summary

First off, thanks for taking the time to contribute! ❤️

All types of contributions are encouraged and valued. See the Table of Contents for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉

You do not have to be a member of AIDA User Group to contribute, although becoming a member is free. Strength is always in the number. Check it out.

And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about: - Star the project. - Tweet about it. - Refer this project in your project's readme. - Mention the project at local meetups and tell your friends/colleagues.

Table of Contents

Code of Conduct

This project and everyone participating in it is governed by the Open Data Contract Standard Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to @jgperrin.

I Have a Question

** New **

AIDA User Group also opened its Slack for Data Contract discussion. It is an alternate way of contributing to this project. The Slack channel is now available.

You have to be a member of AIDA User Group (it's free) to have access to our Slack channel. All the details are here.

If you want to ask a question, we assume that you have read the available Documentation.

Before you ask a question, it is best to search for existing Issues that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.

If you then still feel the need to ask a question and need clarification, we recommend the following:

  • Open a New Issue.
  • Provide as much context as you can about what you're running into.

We will then take care of the issue as soon as possible.

I Want To Contribute

When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for Data Contract Template, including completely new features and minor improvements to existing functionality. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.

Before Submitting an Enhancement

  • Make sure that you are using the latest version.
  • Read the documentation carefully and find out if the functionality is already covered.
  • Perform a search to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
  • Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset.

How Do I Submit a Good Enhancement Suggestion?

Enhancement suggestions are tracked as GitHub issues.

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • Describe the current behavior and explain which behavior you expected to see instead and why. At this point you can also tell which alternatives do not work for you.
  • Explain why this enhancement would be useful to most Open Data Contract Standard users. You may also want to point out the other projects that solved it better and which could serve as inspiration.

Improving The Documentation

Please contact @jgperrin. Examples are always welcome.

Join The Project Team

Please contact @jgperrin.