feat(repo): make github repository public (#43)

* docs(typos): correct * feat(release): make repository public
kiran94 · May 28, 2023 · 5d215e4 · 5d215e4
1 parent 2fc52c2
commit 5d215e4
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -106,7 +106,7 @@ Learn more about `involves` [here](https://docs.github.com/en/search-github/sear
 
 #### User Reviewed
 
-`prfiesta` exposes a `--use-reviewed-by` flag which will collect pull requests where the user has reviewed others pull requests.
+`prfiesta` exposes a `--use-reviewed-by` flag which will collect pull requests where the user *has reviewed* other's pull requests.
 
 Learn more about searching review requests [here](https://docs.github.com/en/search-github/searching-on-github/searching-issues-and-pull-requests#search-by-pull-request-review-status-and-reviewer)
 
@@ -118,7 +118,7 @@ Learn more about searching review requests [here](https://docs.github.com/en/sea
 
 ### Date Filter
 
-When using the `--after` and `--before` date filters, by default `prfiesta` will use the `created` date dimension with these filters on the Git provider (e.g GitHub). This may not fit your use case and you may want to filter on when a pull request was updated instead. To do this you can use the `--use-updated` flag.
+When using the `--after` and `--before` date filters, by default `prfiesta` will use the `created` date dimension with these filters on the Git provider (e.g GitHub). This may not fit your use case and you may want to filter on when a pull request was `updated` instead. To do this you can use the `--use-updated` flag.
 
 Learn more about date filters [here](https://docs.github.com/en/search-github/searching-on-github/searching-issues-and-pull-requests#search-by-when-an-issue-or-pull-request-was-created-or-last-updated).
 
@@ -190,7 +190,7 @@ precommit_run
 
 When you create a pull request on this repository, various CI checks are run, towards the end of those checks there is a `release` job.
 
-Usually when running under `main`, this job is responsible for publishing new versions to pypi. However when running under a pull request, this will create a special prerelease package specific to that pull reuqest.
+Usually when running under `main`, this job is responsible for publishing new versions to pypi. However when running under a pull request, this will create a special prerelease package specific to that pull request.
 
 The versioning of this package follows [PEP-440](https://peps.python.org/pep-0440/#pre-releases) and will look something like this:
 

diff --git a/docs/analysis.md b/docs/analysis.md
@@ -16,7 +16,7 @@ prfiesta ships with built in plots to help analyze your pull request data. These
 | ---------------                                             | ---------------                                                                                                                                                                                                                                                  | ------                                                              |
 | `prfiesta.analysis.plot.plot_overall_timeline`              | Produces a plot showing contributions over time catagorized by month and year                                                                                                                                                                                    | [Link](../notebooks/plots/plot_overall_contribution_timeline.ipynb) |
 | `prfiesta.analysis.plot.plot_state_distribution`            | Produces a plot showing the distribution of state (open or closed PR) catagorized by repository                                                                                                                                                                  | [Link](../notebooks/plots/plot_state_distribution.ipynb)            |
-| `prfiesta.analysis.plot.plot_author_associations`           | Produces a plot showing authors association to the repository contribued to                                                                                                                                                                                      | [Link](../notebooks/plots/plot_author_association.ipynb)            |
+| `prfiesta.analysis.plot.plot_author_associations`           | Produces a plot showing authors association to the repository contributed to                                                                                                                                                                                      | [Link](../notebooks/plots/plot_author_association.ipynb)            |
 | `prfiesta.analysis.plot.plot_conventional_commit_breakdown` | Produces a plot showing [git conventional commit](https://www.conventionalcommits.org/en/v1.0.0/) breakdown for contributions catagorized by repository name. Note that this requires the user to use conventional commit messages in their pull request titles. | [Link](../notebooks/plots/plot_conventional_commit_breakdown.ipynb) |
 | `prfiesta.analysis.plot.plot_reactions`                     | Produces a plot showing distribution of [GitHub Reactions](https://docs.github.com/en/rest/reactions?apiVersion=2022-11-28)                                                                                                                                      | [Link](../notebooks/plots/plot_reactions.ipynb)                     |
 
@@ -56,6 +56,6 @@ def plot_my_cool_plot(data: pd.DataFrame, **kwargs) -> Union[plt.Figure, plt.Axe
     pass
 ```
 
-All prfiesta should accept the the same `kwargs` mentioned in the above table however implementation of these `kwargs` per plot is on a best effort basis.
+All prfiesta should accept the same `kwargs` mentioned in the above table however implementation of these `kwargs` per plot is on a best effort basis.
 
 **If you build a plot which you think will be useful for others then feel free to contribute it to this project 🚀**
diff --git a/terraform/github.tf b/terraform/github.tf
@@ -1,7 +1,7 @@
 resource "github_repository" "main" {
   name         = "prfiesta"
   description  = "Collect and Analyze Individual Contributor Pull Requests"
-  visibility   = "private"
+  visibility   = "public"
   homepage_url = "https://pypi.org/project/prfiesta/"
 
   has_projects  = false