Merge pull request #134 from qmd-lab/133-add-open-source-guiding-docs

Open source guiding docs

CONTRIBUTING.md

@@ -0,0 +1,18 @@
+# Contributing
+
+You can contribute to Closeread in many ways:
+
+- By opening issues and starting discussions to provide feedback and share ideas
+- By submitting Pull Request (PR) to fix opened issues
+- By submitting Pull Request (PR) to suggest new features (it is considered good practice to open an issue for discussion before working on a pull request for a new feature).
+
+## Pull Requests
+
+Pull requests are very welcome! Here's how to contribute via PR:
+
+1.  Fork the repository, clone it locally, and make your changes in a new branch specific to the PR.
+2.  Submit the [pull request](https://help.github.com/articles/using-pull-requests) into the `dev` branch. It is ok to submit as "draft" if you are still working on it but would like some feedback from us. It always good to share in the open that you are working on it.
+3.  The maintainers will provide feedback on the PR and if its within scope and well-implemented, it will get merged into `dev`.
+4.  Once there is a critical mass of new features and fixes on `dev`, it will be merged into `main` and a new version of Closeread will be released.
+
+We'll try to be as responsive as possible in reviewing and accepting pull requests.

LICENSE.md

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright (c) 2024 closeread contributors
+
+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.