Merge pull request #249 from qir-alliance/tnguyen/devel

Update qcor url and add some readme text

CONTRIBUTING.md

@@ -0,0 +1,80 @@
+# 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.

README.md

@@ -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 [[email protected]](mailto:[email protected]) for Code of
+Conduct issues or inquires.

docker/ci/alpine/code-server-dev/Dockerfile

@@ -34,7 +34,7 @@ RUN git clone --recursive https://github.com/eclipse/xacc && sudo chown -R coder
     && mv /home/coder/patch_glucose.hpp xacc/tpls/staq/libs/glucose/glucose.hpp \
     && cd xacc && mkdir build && cd build/ \
     && cmake .. -DCMAKE_INSTALL_PREFIX=/usr/local/aideqc/qcor && make -j8 install && cd ../.. \
-    && git clone https://github.com/ornl-qci/qcor && cd qcor && mkdir build && cd build \
+    && git clone https://github.com/qir-alliance/qcor && cd qcor && mkdir build && cd build \
     && cmake .. -G Ninja -DXACC_DIR=/usr/local/aideqc/qcor -DCMAKE_INSTALL_PREFIX=/usr/local/aideqc/qcor \
         -DLLVM_ROOT=/usr/local/aideqc/llvm -DQCOR_EXTRA_COMPILER_FLAGS="-B /usr/lib/gcc/x86_64-alpine-linux-musl/10.3.1 -L /usr/lib/gcc/x86_64-alpine-linux-musl/10.3.1" \
         -DQCOR_EXTRA_HEADERS="/usr/include/c++/10.3.1;/usr/include/c++/10.3.1/x86_64-alpine-linux-musl" \

docker/ci/alpine/code-server/Dockerfile

@@ -17,7 +17,7 @@ ENV USER=coder
 WORKDIR /home/coder
 ADD README.md .
 RUN sudo chown coder README.md && sudo chgrp coder README.md \
-   && git clone https://github.com/ornl-qci/qcor && cp -r qcor/examples cpp-examples \
+   && git clone https://github.com/qir-alliance/qcor && cp -r qcor/examples cpp-examples \
    && cp -r qcor/python/examples py-examples && rm -rf qcor \
    && mkdir -p /home/coder/.local/share/code-server/User \
    && printf "{\"workbench.startupEditor\": \"readme\", \"workbench.colorTheme\": \"Monokai Dimmed\", \"workbench.panel.defaultLocation\": \"right\", \"terminal.integrated.shell.linux\": \"bash\", \"files.associations\": {\"*.qasm\": \"cpp\"}}" | tee /home/coder/.local/share/code-server/User/settings.json \

docker/ci/alpine/code-server/README.md

@@ -1,9 +1,9 @@
-<img src="https://github.com/ornl-qci/qcor/blob/master/docs/assets/qcor_full_logo.svg?raw=true" alt="qcor_fig" width="600"/>
+<img src="https://github.com/qir-alliance/qcor/blob/master/docs/assets/qcor_full_logo.svg?raw=true" alt="qcor_fig" width="600"/>
 
 # Welcome to QCOR
 
 You are using the QCOR web-IDE for heterogeneous quantum-classical computing. <br>
-This project provides a pre-built image containing the entire `qcor` compiler stack, including the [`qcor`](https://github.com/ornl-qci/qcor) <br>
+This project provides a pre-built image containing the entire `qcor` compiler stack, including the [`qcor`](https://github.com/qir-alliance/qcor) <br>
 C++ compiler and Python quantum JIT environment, the [XACC](https://github.com/eclipse/xacc) framework and high-level Python API, <br>
 and the OpenQASM 3 MLIR compiler. 
 

docker/ci/alpine/qcor/Dockerfile

@@ -1,7 +1,7 @@
 FROM qcor/llvm-alpine as llvm_install
 FROM xacc/alpine
 COPY --from=llvm_install /usr/local/aideqc/llvm /usr/local/aideqc/llvm
-RUN apk add libc6-compat ninja bash sudo curl && git clone https://github.com/ornl-qci/qcor && cd qcor && mkdir build && cd build \
+RUN apk add libc6-compat ninja bash sudo curl && git clone https://github.com/qir-alliance/qcor && cd qcor && mkdir build && cd build \
    && cmake .. -G Ninja -DXACC_DIR=/usr/local/aideqc/qcor -DCMAKE_INSTALL_PREFIX=/usr/local/aideqc/qcor -DLLVM_ROOT=/usr/local/aideqc/llvm -DQCOR_EXTRA_COMPILER_FLAGS="-B /usr/lib/gcc/x86_64-alpine-linux-musl/10.3.1 -L /usr/lib/gcc/x86_64-alpine-linux-musl/10.3.1" -DQCOR_EXTRA_HEADERS="/usr/include/c++/10.3.1;/usr/include/c++/10.3.1/x86_64-alpine-linux-musl" \
    && cmake --build . --target install && cd ../.. && rm -rf qcor \
    && adduser --gecos '' --disabled-password coder \
@@ -17,7 +17,7 @@ RUN apk add libc6-compat ninja bash sudo curl && git clone https://github.com/or
 USER 1000
 ENV USER=coder
 WORKDIR /home/coder
-RUN git clone https://github.com/ornl-qci/qcor && cp -r qcor/examples cpp-examples \
+RUN git clone https://github.com/qir-alliance/qcor && cp -r qcor/examples cpp-examples \
    && cp -r qcor/python/examples py-examples && rm -rf qcor 
 ENV PYTHONPATH "${PYTHONPATH}:/usr/local/aideqc/qcor"
 ENV PATH "${PATH}:/usr/local/aideqc/qcor/bin"

docker/ci/alpine/qsharp-code-server/Dockerfile

@@ -21,7 +21,7 @@ RUN sudo apk add bash icu-libs krb5-libs libgcc libintl libssl1.1 libstdc++ zlib
    && sudo ln -s ~/.dotnet/dotnet /usr/bin/dotnet \
    && dotnet nuget add source "https://pkgs.dev.azure.com/ms-quantum-public/Microsoft Quantum (public)/_packaging/alpha/nuget/v3/index.json" -n qdk-alpha \
    && dotnet new -i Microsoft.Quantum.ProjectTemplates \
-   && git clone https://github.com/ornl-qci/qcor && cp -r qcor/examples cpp-examples && rm -rf qcor \
+   && git clone https://github.com/qir-alliance/qcor && cp -r qcor/examples cpp-examples && rm -rf qcor \
    && sudo apk add llvm \
    && sudo apk add xmlstarlet \
    && xmlstarlet ed --inplace -s /configuration -t elem -n config -v "" \

docker/ci/alpine/qsharp-code-server/README.md

@@ -1,9 +1,9 @@
-<img src="https://github.com/ornl-qci/qcor/blob/master/docs/assets/qcor_full_logo.svg?raw=true" alt="qcor_fig" width="600"/>
+<img src="https://github.com/qir-alliance/qcor/blob/master/docs/assets/qcor_full_logo.svg?raw=true" alt="qcor_fig" width="600"/>
 
 # Welcome to QCOR
 
 You are using the QCOR web-IDE for heterogeneous quantum-classical computing. <br>
-This project provides a pre-built image containing the entire `qcor` compiler stack, including the [`qcor`](https://github.com/ornl-qci/qcor) <br>
+This project provides a pre-built image containing the entire `qcor` compiler stack, including the [`qcor`](https://github.com/qir-alliance/qcor) <br>
 C++ compiler and Python quantum JIT environment, the [XACC](https://github.com/eclipse/xacc) framework and high-level Python API, <br>
 and the OpenQASM 3 MLIR compiler. 
 

docker/ci/ubuntu1804/devel/Dockerfile

@@ -2,6 +2,6 @@ from xacc/ubuntu:18.04
 run git clone --recursive -b xacc-devel https://github.com/eclipse/xacc && cd xacc && mkdir build && cd build \
     && cmake .. \
     && make -j$(nproc) install \
-    && cd ../../ && git clone -b devel https://github.com/ornl-qci/qcor && cd qcor && mkdir build && cd build \
+    && cd ../../ && git clone -b devel https://github.com/qir-alliance/qcor && cd qcor && mkdir build && cd build \
     && cmake .. -DXACC_DIR=~/.xacc -DQCOR_BUILD_TESTS=TRUE \
     && make -j$(nproc) install && ctest --output-on-failure

docker/ci/ubuntu1804/master/Dockerfile

@@ -2,6 +2,6 @@ from qcor/deploy-base
 run git clone --recursive https://github.com/eclipse/xacc && cd xacc && mkdir build && cd build \
     && cmake .. \
     && make -j$(nproc) install 
-run cd ../../ && git clone -b master https://github.com/ornl-qci/qcor && cd qcor && mkdir build && cd build \
+run cd ../../ && git clone -b master https://github.com/qir-alliance/qcor && cd qcor && mkdir build && cd build \
     && cmake .. -DXACC_DIR=~/.xacc -DLLVM_ROOT=/usr/local/aideqc/llvm -DMLIR_DIR=/usr/local/aideqc/llvm/lib/cmake/mlir -DQCOR_BUILD_TESTS=TRUE \
     && make -j$(nproc) install && ctest --output-on-failure

docker/qsharp/Dockerfile

@@ -15,6 +15,6 @@ RUN git clone --recursive https://github.com/eclipse/xacc && cd xacc && mkdir bu
     && cmake .. \
     && make -j$(nproc) install 
 
-RUN cd ../../ && git clone -b master https://github.com/ornl-qci/qcor && cd qcor && mkdir build && cd build \
+RUN cd ../../ && git clone -b master https://github.com/qir-alliance/qcor && cd qcor && mkdir build && cd build \
     && cmake .. -DXACC_DIR=~/.xacc -DLLVM_ROOT=/usr/local/aideqc/llvm -DMLIR_DIR=/usr/local/aideqc/llvm/lib/cmake/mlir -DQCOR_BUILD_TESTS=TRUE \
     && make -j$(nproc) install && ctest --output-on-failure

docs/build/html/_sources/index.rst.txt

@@ -38,7 +38,7 @@ Questions, Bug Reporting, and Issue Tracking
 ---------------------------------------------
 
 Questions, bug reporting and issue tracking are provided by GitHub. Please
-report all bugs by creating a `new issue <https://github.com/ornl-qci/qcor/issues/new>`_.
+report all bugs by creating a `new issue <https://github.com/qir-alliance/qcor/issues/new>`_.
 You can ask questions by creating a new issue with the question tag.
 
 .. toctree::

docs/build/html/_sources/install.rst.txt

@@ -44,7 +44,7 @@ Note that, for now, developers must clone QCOR manually:
 
 .. code:: bash 
 
-   $ git clone https://github.com/ornl-qci/qcor
+   $ git clone https://github.com/qir-alliance/qcor
    $ cd qcor && mkdir build && cd build
    $ cmake .. 
    $ [with tests] cmake .. -DQCOR_BUILD_TESTS=TRUE

docs/build/html/index.html

@@ -183,7 +183,7 @@ <h2>QCOR Development Team<a class="headerlink" href="#qcor-development-team" tit
 <div class="section" id="questions-bug-reporting-and-issue-tracking">
 <h2>Questions, Bug Reporting, and Issue Tracking<a class="headerlink" href="#questions-bug-reporting-and-issue-tracking" title="Permalink to this headline">¶</a></h2>
 <p>Questions, bug reporting and issue tracking are provided by GitHub. Please
-report all bugs by creating a <a class="reference external" href="https://github.com/ornl-qci/qcor/issues/new">new issue</a>.
+report all bugs by creating a <a class="reference external" href="https://github.com/qir-alliance/qcor/issues/new">new issue</a>.
 You can ask questions by creating a new issue with the question tag.</p>
 <div class="toctree-wrapper compound">
 <p class="caption"><span class="caption-text">Contents:</span></p>

docs/build/html/install.html

@@ -196,7 +196,7 @@ <h2>Dependencies<a class="headerlink" href="#dependencies" title="Permalink to t
 <div class="section" id="building-from-scratch">
 <h2>Building from Scratch<a class="headerlink" href="#building-from-scratch" title="Permalink to this headline">¶</a></h2>
 <p>Note that, for now, developers must clone QCOR manually:</p>
-<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ git clone https://github.com/ornl-qci/qcor
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ git clone https://github.com/qir-alliance/qcor
 $ <span class="nb">cd</span> qcor <span class="o">&amp;&amp;</span> mkdir build <span class="o">&amp;&amp;</span> <span class="nb">cd</span> build
 $ cmake ..
 $ <span class="o">[</span>with tests<span class="o">]</span> cmake .. -DQCOR_BUILD_TESTS<span class="o">=</span>TRUE

docs/source/index.rst

@@ -38,7 +38,7 @@ Questions, Bug Reporting, and Issue Tracking
 ---------------------------------------------
 
 Questions, bug reporting and issue tracking are provided by GitHub. Please
-report all bugs by creating a `new issue <https://github.com/ornl-qci/qcor/issues/new>`_.
+report all bugs by creating a `new issue <https://github.com/qir-alliance/qcor/issues/new>`_.
 You can ask questions by creating a new issue with the question tag.
 
 .. toctree::

docs/source/install.rst

@@ -44,7 +44,7 @@ Note that, for now, developers must clone QCOR manually:
 
 .. code:: bash 
 
-   $ git clone https://github.com/ornl-qci/qcor
+   $ git clone https://github.com/qir-alliance/qcor
    $ cd qcor && mkdir build && cd build
    $ cmake .. 
    $ [with tests] cmake .. -DQCOR_BUILD_TESTS=TRUE

scripts/get_git_version.sh

@@ -1,2 +1,2 @@
 #!/bin/bash
-git ls-remote https://github.com/ornl-qci/qcor HEAD | awk '{ print $1}' | head -c 7
+git ls-remote https://github.com/qir-alliance/qcor HEAD | awk '{ print $1}' | head -c 7