From 352b954c562136778caf4ac13eb490c9b12e82f4 Mon Sep 17 00:00:00 2001 From: andrewpbray Date: Thu, 7 Nov 2024 14:28:41 -0800 Subject: [PATCH 1/5] initial commit --- CONTRIBUTING.md | 19 +++++++++++++++++++ LICENSE.md | 21 +++++++++++++++++++++ 2 files changed, 40 insertions(+) create mode 100644 CONTRIBUTING.md create mode 100644 LICENSE.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..f4c9b79 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,19 @@ +# Contributing + +You can contribute to Closeread in many ways: + +- By opening issues 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). + +Please be mindful of our [code of conduct](https://github.com/quarto-dev/quarto-cli/blob/main/.github/CODE_OF_CONDUCT.md) as you interact with other community members. + +## 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. For significant changes (e.g more than small bug fixes), ensure that you have signed the [individual](https://posit.co/wp-content/uploads/2023/04/2023-03-13_TC_Indiv_contrib_agreement.pdf) or [corporate](https://posit.co/wp-content/uploads/2023/04/2023-03-13_TC_Corp_contrib_agreement.pdf) contributor agreement as appropriate. You can send the signed copy to [jj\@rstudio.com](mailto:jj@rstudio.com){.email}. +3. Submit the [pull request](https://help.github.com/articles/using-pull-requests). It is ok to submit as draft in your 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. + +We'll try to be as responsive as possible in reviewing and accepting pull requests. \ No newline at end of file diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..f0f0263 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,21 @@ +# MIT License + +Copyright (c) 2024 closeread authors + +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. \ No newline at end of file From f4f28adfce9f70a1d25b2984e89c372ba5891818 Mon Sep 17 00:00:00 2001 From: andrewpbray Date: Fri, 8 Nov 2024 14:55:00 -0800 Subject: [PATCH 2/5] assign copyright to contributors and guide their PRs. --- CONTRIBUTING.md | 5 +++-- LICENSE.md | 2 +- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f4c9b79..a3596b0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -13,7 +13,8 @@ Please be mindful of our [code of conduct](https://github.com/quarto-dev/quarto- 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. For significant changes (e.g more than small bug fixes), ensure that you have signed the [individual](https://posit.co/wp-content/uploads/2023/04/2023-03-13_TC_Indiv_contrib_agreement.pdf) or [corporate](https://posit.co/wp-content/uploads/2023/04/2023-03-13_TC_Corp_contrib_agreement.pdf) contributor agreement as appropriate. You can send the signed copy to [jj\@rstudio.com](mailto:jj@rstudio.com){.email}. -3. Submit the [pull request](https://help.github.com/articles/using-pull-requests). It is ok to submit as draft in your 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. +2. Submit the [pull request](https://help.github.com/articles/using-pull-requests) into the `dev` branch. It is ok to submit as "draft" in your 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 fixed 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. \ No newline at end of file diff --git a/LICENSE.md b/LICENSE.md index f0f0263..53d5209 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,6 +1,6 @@ # MIT License -Copyright (c) 2024 closeread authors +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 From 3e03438094108ef9080e8a258040283323b559b2 Mon Sep 17 00:00:00 2001 From: andrewpbray Date: Fri, 8 Nov 2024 15:00:41 -0800 Subject: [PATCH 3/5] fix typo --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a3596b0..4c65d43 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -15,6 +15,6 @@ 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" in your 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 fixed on `dev`, it will be merged into `main` and a new version of Closeread will be released. +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. \ No newline at end of file From f380a62ae79e9b403f9d67d1296ab6fdd266dd1f Mon Sep 17 00:00:00 2001 From: andrewpbray Date: Mon, 11 Nov 2024 07:39:39 -0800 Subject: [PATCH 4/5] remove c of c --- CONTRIBUTING.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4c65d43..5243c3a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,8 +6,6 @@ You can contribute to Closeread in many ways: - 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). -Please be mindful of our [code of conduct](https://github.com/quarto-dev/quarto-cli/blob/main/.github/CODE_OF_CONDUCT.md) as you interact with other community members. - ## Pull Requests Pull requests are very welcome! Here's how to contribute via PR: From f43846703a3853d644ea32990e894b2c30d86d67 Mon Sep 17 00:00:00 2001 From: James Goldie Date: Tue, 12 Nov 2024 09:32:33 +1100 Subject: [PATCH 5/5] Add discussion ref to CONTRIBUTING.md --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5243c3a..509250a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,7 +2,7 @@ You can contribute to Closeread in many ways: -- By opening issues to provide feedback and share ideas. +- 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). @@ -11,7 +11,7 @@ You can contribute to Closeread in many ways: 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" in your 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. +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.