From 68cbbc49b79151c1688872dcfbefa37903422625 Mon Sep 17 00:00:00 2001 From: Niven <61798667+NivenPrasad@users.noreply.github.com> Date: Sat, 5 Dec 2020 17:33:37 -0500 Subject: [PATCH 1/4] Create SUPPORT.md --- SUPPORT.md | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 SUPPORT.md diff --git a/SUPPORT.md b/SUPPORT.md new file mode 100644 index 0000000..2824fe7 --- /dev/null +++ b/SUPPORT.md @@ -0,0 +1,7 @@ +Detailed documentation is included in the [readme](https://github.com/100Automations/true-github-contributors/blob/mixin/readme.md). + +For any questions, please feel free to drop into the [100 Automations slack](https://hackforla.slack.com/archives/C018S5TCQE7) and @ mention me (@Sophia Alice) to ask any questions. If you are not a member of the Hack for LA slack you can join [here](https://hackforla.org/slack). + +For any issues and non-security related bugs that feel like they could be resolved through development, please open a detailed issue on the issue and why. This way, there can be room to have a productive discussion before any changes are made. It can be discussed if the change is a good fit for this project, fine tune goals, and more. + +If you would like to contribute code in response to any issues or support related needs, see the Contributing Guide. From 9522d7a02019e1b6e0f070754d05cc961004d6a1 Mon Sep 17 00:00:00 2001 From: Niven <61798667+NivenPrasad@users.noreply.github.com> Date: Sat, 5 Dec 2020 17:38:33 -0500 Subject: [PATCH 2/4] Create CONTRIBUTING.md --- CONTRIBUTING.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..bd42eec --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,15 @@ +## How to contribute + +For any contribution you had in mind, please open a detailed issue on what you are contributing and why. This way, there can be room to have a productive discussion before any code is written. It can be discussed if the contribution is a good fit for this project, fine tune contribution goals, and more. +Feel free to drop into the [100 Automations slack](https://hackforla.slack.com/archives/C018S5TCQE7) to reach out to me to ask any questions. + +## Testing +As of right now, there are no concrete testing practices. Tests on any further development will be implemented are done using [pytest](https://docs.pytest.org/en/stable/). If you would like to contribute, it would be best to use jest so that the project isn't dependent on multiple testing libraries. + +## Submitting changes +Please fork this repository and create a Pull Request to this project from that fork ([How to fork a repo](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo)). In that pull request, please include thorough tests for whatever feature you are adding. If you would just like to submit more or better tests for currently existing features, that would also be much appreciated and helpful. +Please only add one feature per pull request and have clear commit messages in them. + +## Coding conventions +Please add code in a similar style/fashion to how code is currently written. +Thank you for being interested in contributing. From e94665c6a5a0e6d10b70ac5a278a18733c26a215 Mon Sep 17 00:00:00 2001 From: Niven <61798667+NivenPrasad@users.noreply.github.com> Date: Sat, 5 Dec 2020 17:42:59 -0500 Subject: [PATCH 3/4] Create SECURITY.md --- SECURITY.md | 4 ++++ 1 file changed, 4 insertions(+) create mode 100644 SECURITY.md diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..4dc0351 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,4 @@ +## Security Policy +### Reporting a Vulnerability + +Feel free to drop into the 100 Automations slack and @ mention me (@Sophia Alice) to report any vulnerabilities. If you are not a member of the Hack for LA slack you can join [here](https://hackforla.org/slack) From 0de1e2f580f279818d2841140aa82997c2126112 Mon Sep 17 00:00:00 2001 From: Niven <61798667+NivenPrasad@users.noreply.github.com> Date: Sat, 5 Dec 2020 17:47:14 -0500 Subject: [PATCH 4/4] Update SUPPORT.md --- SUPPORT.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/SUPPORT.md b/SUPPORT.md index 2824fe7..14baf03 100644 --- a/SUPPORT.md +++ b/SUPPORT.md @@ -1,4 +1,4 @@ -Detailed documentation is included in the [readme](https://github.com/100Automations/true-github-contributors/blob/mixin/readme.md). +Detailed documentation is included in the [readme](https://github.com/100Automations/github-actions/blob/master/README.md). For any questions, please feel free to drop into the [100 Automations slack](https://hackforla.slack.com/archives/C018S5TCQE7) and @ mention me (@Sophia Alice) to ask any questions. If you are not a member of the Hack for LA slack you can join [here](https://hackforla.org/slack).