Skip to content
This repository has been archived by the owner on May 5, 2021. It is now read-only.

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
imodeljs-admin committed Sep 9, 2019
0 parents commit 5bcc21b
Show file tree
Hide file tree
Showing 4 changed files with 111 additions and 0 deletions.
Binary file added Bentley-CLA.pdf
Binary file not shown.
95 changes: 95 additions & 0 deletions CONTRIBUTING.md
@@ -0,0 +1,95 @@
# Contributing to iModel.js Samples

Welcome, and thank you for your interest in contributing to the iModel.js samples!

There are many ways to contribute.
The goal of this document is to provide a high-level overview of how you can get involved.

## Asking Questions

Have a question?
Rather than opening an issue, please ask away on [Stack Overflow](https://stackoverflow.com/tags/imodeljs) using the tag `imodeljs`.

The community will be eager to assist you. Your well-worded question will serve as a resource to others searching for help.

## Providing Feedback

Your comments and feedback are welcome. For general comments or discussion please [click here](https://github.com/imodeljs/imodeljs-samples/labels/discussion) to contribute via GitHub issues using the `discussion` label.

## Reporting Issues

Have you identified a reproducible problem in iModel.js?
Have a feature request?
We want to hear about it!
Here's how you can make reporting your issue as effective as possible.

### Look For an Existing Issue

Before you create a new issue, please do a search in [open issues](https://github.com/imodeljs/imodeljs-samples/issues) to see if the issue or feature request has already been filed.

If you find that your issue already exists, please add relevant comments and your [reaction](https://github.com/blog/2119-add-reactions-to-pull-requests-issues-and-comments).
Use a reaction in place of a "+1" comment:

* 👍 - upvote
* 👎 - downvote

If you cannot find an existing issue that describes your bug or feature, create a new issue using the guidelines below.

### Writing Good Bug Reports and Feature Requests

File a single issue per problem and feature request.
Do not enumerate multiple bugs or feature requests in the same issue.

Do not add your issue as a comment to an existing issue unless it's for the identical input.
Many issues look similar, but have different causes.

The more information you can provide, the more likely someone will be successful reproducing the issue and finding a fix.

Please include the following with each issue:

* A short description of the issue that becomes the title
* Versions of relevant iModel.js packages
* Minimal steps to reproduce the issue or a code snippet that demonstrates the issue
* What you expected to see, versus what you actually saw
* Images that help explain the issue
* Any relevant error messages, logs, or other details
* Impact of the issue
* Use the [`bug`](https://github.com/imodeljs/imodeljs-samples/labels/bug) or [`enhancement`](https://github.com/imodeljs/imodeljs-samples/labels/enhancement) label to identify the type of issue you are filing

Don't feel bad if the developers can't reproduce the issue right away.
They will simply ask for more information!

### Follow Your Issue

You may be asked to clarify things or try different approaches, so please follow your issue and be responsive.

## Contributions

We'd love to accept your contributions to iModel.js.
There are just a few guidelines you need to follow.

### Contributor License Agreement (CLA)

You must sign a [Contribution License Agreement with Bentley](Bentley-CLA.pdf) before your contributions will be accepted.
This a one-time requirement for Bentley projects in GitHub.
You can read more about [Contributor License Agreements](https://en.wikipedia.org/wiki/Contributor_License_Agreement) on Wikipedia.

> Note: a CLA is not required if the change is trivial (such as fixing a spelling error or a typo).
### Pull Requests

All submissions go through a review process.
We use GitHub pull requests for this purpose.
Consult [GitHub Help](https://help.github.com/articles/about-pull-requests/) for more information on using pull requests.

### Types of Contributions

We welcome contributions, large or small, including:

* Bug fixes
* New features
* Documentation corrections or additions
* Example code snippets
* Sample data

Thank you for taking the time to contribute to open source and making great projects like iModel.js possible!
9 changes: 9 additions & 0 deletions LICENSE.md
@@ -0,0 +1,9 @@
# MIT License

Copyright © 2019 Bentley Systems, Incorporated. All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
7 changes: 7 additions & 0 deletions README.md
@@ -0,0 +1,7 @@
# iModel.js Samples

Copyright © 2019 Bentley Systems, Incorporated. All rights reserved.

The [iModel.js](http://imodeljs.org) library is an open source platform for creating, querying, modifying, and displaying iModels. This repository contains sample code walking through the iModel.js API.

If you have questions, or wish to contribute to the iModel.js samples, see our [Contributing guide](./CONTRIBUTING.md).

0 comments on commit 5bcc21b

Please sign in to comment.