Commit dba13729 authored by Nguyen, Thien Minh's avatar Nguyen, Thien Minh
Browse files

Adding some markdown docs to look consistent with other repos under QIR-A


Signed-off-by: Nguyen, Thien Minh's avatarThien Nguyen <nguyentm@ornl.gov>
parent e20a61ec
# Contributing
Thank you for your interest in contributing to QCOR!
There are many ways in which you can contribute to QCOR, whether by
contributing a feature or by engaging in discussions; we value contributions in
all shapes and sizes! The following sections may give some ideas for how you can
get involved.
## Asking and Answering Questions
Have a question? This repository is a great place to ask questions
about the compilation of quantum programs to QIR and
the QIR runtime based on [XACC](https://github.com/eclipse/xacc).
Your question will serve as resource to others
searching for help. Please file an issue to ask your question
[here](https://github.com/qir-alliance/qcor/issues/new).
Or maybe you have figured out how that hard-to-understand concept works? Share
your knowledge! If you are interested in contributing to the documentation
around QIR and its tools, please follow the standard development process on the
respective repository to improve the materials.
## Reporting and Commenting on Issues
Have you identified an issue or modification that would benefit the community?
We want to hear about it! If you have feedback about the content in this
repository, please let us know by filing a [new
issue](https://github.com/qir-alliance/qcor/issues/new)!
As for any active effort, there are always many ways in which we hope to evolve
and improve the specification and tools. We encourage you to look at the list of
currently [open issues](https://github.com/qir-alliance/qcor/issues) to share
your ideas and expertise.
## Contributing Code
If you are interested in helping fix issues you or someone else encountered,
please make sure that the corresponding issue has been filed on the repository.
Check that nobody is currently working on it and that it has indeed been marked
as bug. If that's the case, indicate on the issue that you are working on it,
and link to the corresponding GitHub page where the fix is being developed. If
someone is already working on a fix, ask if you can help or see what other
things can be done. If an issue is labeled as feature, please follow the
guidelines related to contributing features. If an issue has not been labeled
yet, please indicate that you would like to work on it and be patient - we are a
small team and are doing our best to be quick with responding to your inquiry!
If you are interested in contributing a new feature, please first check if a
similar functionality has already been requested. If so, consider contributing
to the discussion around it rather than filing a separate issue. If no open or
closed issue with such a request already exists, please file one following the
[feature request
template](https://github.com/qir-alliance/qcor/issues/new?assignees=&labels=feature&template=feature_request.md&title=).
We will respond to feature requests and follow up with a discussion around its
feasibility, how one might go about implementing it, and whether that is
something that makes sense to add. There are several reasons why we might not be
able to eventually merge even a great feature for one reason or another. Perhaps
most commonly, a contribution is a really good one, but this isn't the right
place to develop it or we simply aren't ready to maintain and develop it
further. It can be difficult to do everything, so we are careful to prioritize
the quality and reliability across the code base over new features. In such
cases, we strongly encourage you to pursue your passion project in your own
fork, and welcome sharing and discussing your thoughts and progress on the
corresponding issue regardless. We'll also ask for changes to a pull request if
it requires more documentation or unit tests to better make use of it.
If you are looking for a place to get started with contributing code, search for
example for the
[good-first-issue](https://github.com/qir-alliance/qcor/labels/good%20first%20issue)
or [help-wanted](https://github.com/qir-alliance/qcor/labels/help%20wanted)
labels. Also, look for issues that have already been discussed in more detail,
and check if you can help someone who has already started working on it.
And last but not least:
## Thank You
Your contributions to open source, large or small, make great projects like this
possible. Thank you for taking the time to contribute.
\ No newline at end of file
......@@ -55,3 +55,30 @@ archivePrefix = {arXiv},
adsnote = {Provided by the SAO/NASA Astrophysics Data System}
}
```
## Feedback
If you have feedback about the content in this repository, please let us know by
filing a [new issue](https://github.com/qir-alliance/qcor/issues/new)!
## Contributing
There are many ways in which you can contribute to QCOR, whether by contributing
a feature or by engaging in discussions; we value contributions in all shapes
and sizes! We refer to [this document](CONTRIBUTING.md) for guidelines and ideas
for how you can get involved.
Contributing a pull request to this repo requires to agree to a
[Contributor License Agreement (CLA)](https://en.wikipedia.org/wiki/Contributor_License_Agreement)
declaring that you have the right to, and actually do, grant us the rights to
use your contribution. We are still working on setting up a suitable CLA-bot to
automate this process. A CLA-bot will automatically determine whether you need
to provide a CLA and decorate the PR appropriately. Once it is set up, simply
follow the instructions provided by the bot. You will only need to do this once.
## Code of Conduct
This project has adopted the community covenant
[Code of Conduct](https://github.com/qir-alliance/.github/blob/main/Code_of_Conduct.md#contributor-covenant-code-of-conduct).
Please contact [qiralliance@mail.com](mailto:qiralliance@mail.com) for Code of
Conduct issues or inquires.
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment