From 134882b24b3179eca1455d778eff6da8d4f0a29f Mon Sep 17 00:00:00 2001 From: nc1z Date: Sun, 21 Apr 2024 11:12:53 +0800 Subject: [PATCH 1/2] feat: added template README.md and removed .DS_Store(s) --- .DS_Store | Bin 6148 -> 0 bytes .gitignore | 25 ++++++++++ README.md | 111 ++++++++++++++++++++++++++++++++++++++++++ tensor-api/.DS_Store | Bin 8196 -> 0 bytes tensor-api/.gitignore | 3 +- vector-api/.gitignore | 3 +- 6 files changed, 140 insertions(+), 2 deletions(-) delete mode 100644 .DS_Store create mode 100644 .gitignore create mode 100644 README.md delete mode 100644 tensor-api/.DS_Store diff --git a/.DS_Store b/.DS_Store deleted file mode 100644 index 1826c330bdee7215a1ba4293f4c275103b13b51f..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 6148 zcmeHKL2uJA6n<{YmTp4o0i+!*aV?{iQ3-JgWgNH?#10!O$yz}~h^r=D4ppU`;m7Q{ zU&7znzGr)gwcTkFLeqQE^JhQ5&#k{$c1%QSI3GVJ>JU)?XKb`lY%uO;U$cgfYyp)W z!_bVLQcP1y*Rmz>KPtfQZih;mP)-H?_5R*x<}}Gnf_^Lx#S5f=Y0XY!BPXefspniI z(=08@UhlVRG+Ph0wu9|pH~1WVGgVZ^<-8civtw?3G$u=~>v8faom8XFqqin6<20Yl zEFm3FkaBXA=3`S0%{(6$mK(W_pdGYFoxR24p#QR~`-8!x-8xX%D*&*C zur<{AQ;|8^W9YGVh#r`7RG_0Of5lLaj=1)Dp~u>xqm%NN59NPZ`5TJ;P(`NFC}1kI zAcZI(3alv5bnOnG|L< + project-logo +

+

+

PROFANITY.DEV

+

+

+ A fast, free and open-source profanity filter for your web apps +

+ +## Overview + +
+ Table of Contents
+ +- [ Overview](#-overview) +- [ Getting Started](#-getting-started) + - [ Installation](#-installation) + - [ Usage](#-usage) + - [ Tests](#-tests) +- [ Project Roadmap](#-project-roadmap) +- [ Contributing](#-contributing) +- [ License](#-license) +- [ Acknowledgments](#-acknowledgments) +
+ +### Project structure + +```sh +└── profanity.dev/ + ├── tensor-api # Hono server + ├── vector-api # Hono server + └── www # NextJs application +``` + +## Getting Started + +**System Requirements:** + +:construction: + +### Installation + +:construction: + +### Usage + +:construction: + +### Tests + +:construction: + +## Project Roadmap + +- [x] `► INSERT-TASK-1` +- [ ] `► INSERT-TASK-2` +- [ ] `► ...` + +## Contributing + +Contributions are welcome! Here are several ways you can contribute: + +- **[Report Issues](https://github.com/joschan21/profanity.dev/issues)**: Submit bugs found or log feature requests for the `profanity.dev` project. +- **[Submit Pull Requests](https://github.com/joschan21/profanity.dev/blob/main/CONTRIBUTING.md)**: Review open PRs, and submit your own PRs. +- **[Join the Discussions](https://github.com/joschan21/profanity.dev/discussions)**: Share your insights, provide feedback, or ask questions. + +
+Contributing Guidelines + +1. **Fork the Repository**: Start by forking the project repository to your github account. +2. **Clone Locally**: Clone the forked repository to your local machine using a git client. + ```sh + git clone https://github.com//profanity.dev + ``` +3. **Create a New Branch**: Always work on a new branch, giving it a descriptive name. + ```sh + git checkout -b new-feature-x + ``` +4. **Make Your Changes**: Develop and test your changes locally. +5. **Commit Your Changes**: Commit with a clear message describing your updates. + ```sh + git commit -m 'feat: implemented new feature x.' + ``` +6. **Push to github**: Push the changes to your forked repository. + ```sh + git push -u origin new-feature-x + ``` +7. **Submit a Pull Request**: Create a PR against the original project repository. Clearly describe the changes and their motivations. +8. **Review**: Once your PR is reviewed and approved, it will be merged into the main branch. Congratulations on your contribution! +
+ +
+Contributor Graph +
+

+ + + +

+
+ +## License + +This project is protected under the [SELECT-A-LICENSE](https://choosealicense.com/licenses) License. For more details, refer to the [LICENSE](https://choosealicense.com/licenses/) file. + +## Acknowledgments + +- List any resources, contributors, inspiration, etc. here. + +[**Return**](#-overview) diff --git a/tensor-api/.DS_Store b/tensor-api/.DS_Store deleted file mode 100644 index acc3f8641e85b6bb1bd69fe73b3172a5748e187d..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 8196 zcmeHM&2G~`5T0!Vb?9G^iqr#0mbjMCmQo3E2_Zdj=%qpB0H{skkcK+mC{CJIRi&Ka z9XRj;TsZIo+&OXO$}1ot!8c>4vK>c3y#VTNwL8vwzMYwGcgJ3rh*YuXtPw2}k%h`K zH;X2v@O`c$Wh(5s38{dmC$6qlU0ucR+=#a6Fbo(53GnUtj>wY%bQA=YDY4 zw1xr0z@=n>^Mj4bvJlEaASHF6ks|=L4(0&)eU4wpun$$&Yz>cO)8b&QdFj-*w(5pbd!8WK9 zw=&hh=8qz-lLM_5M!zGniq^qjQ%1{w!n zePG0hHT5=OZBCeA{XOy8p`O@IcqwegXQ2)6YIKOU0d$^T!#ho0JUZqlHhT-0D-X4W zs9fmt2zfe@NZmMAn2FC|o99f}tRc3P_=s0a8iu`PYzju*N??}YAL|Y=4!CiE@1pwX zXUi#bA>%|jT9k1#=9AYCue=jP&1-}CPDCp+6ZL!oy4v^K;a9Ft)wbL8yQ`~T)zoz6 z%GDWb#+tQWmJf8l+^uwbezDSd&cB{&?N*1^mFjM@-rvhDJ=R{g()8*b0W_UDR9-x5 zdXDZFb@!z6-9*)OPUXUpSQdgCq(Hs*2*>AY6qC@FOv~1T`GmVSU*30+kOB2Gw-koc3RrG z0IGcu^=_Y?oM7ju-0@uP@vdN27A3dz|7?B9UW%@eEbY)1c1el0A@f*SPJ9RPnu=wo zIjlj>W}J;UKaI&MBe`=PI3H^s`&+V81J+XaJMY<;#Vj4c4)0dZw`seNS3xwYrAWp_ zz6FN;JkRnnhDNN3{WFqB=Og1t<{pRSeVg!^^HB$}=7%{d&MRk`7y==fazO^B1Kjc~ ztzpTj1(fkI#1wst~ diff --git a/tensor-api/.gitignore b/tensor-api/.gitignore index 6fc3aaa..8b75ff2 100644 --- a/tensor-api/.gitignore +++ b/tensor-api/.gitignore @@ -1,4 +1,5 @@ .env node_modules .wrangler -wrangler.toml \ No newline at end of file +wrangler.toml +.DS_Store \ No newline at end of file diff --git a/vector-api/.gitignore b/vector-api/.gitignore index 462edf6..5bb0b05 100644 --- a/vector-api/.gitignore +++ b/vector-api/.gitignore @@ -2,4 +2,5 @@ dist node_modules .env wrangler.toml -.wrwangler \ No newline at end of file +.wrwangler +.DS_Store \ No newline at end of file From 97df5a3a1ebb522f3187990d4bae8c738f9fb65b Mon Sep 17 00:00:00 2001 From: nc1z Date: Sun, 21 Apr 2024 11:25:47 +0800 Subject: [PATCH 2/2] feat: pull request template --- .github/PULL_REQUEST_TEMPLATE.md | 37 ++++++++++++++++++++++++++++++++ README.md | 4 ++-- 2 files changed, 39 insertions(+), 2 deletions(-) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..ebda541 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,37 @@ + + +## Description + +Describe the technical changes you did. + +## Why is it needed? + +Describe the issue you are solving. + +## Screenshot or GIFs (if applicable) + +If the changes include visual modifications, include screenshots or GIFs to demonstrate the before and after effects. + +## Testing + +Describe the testing strategy employed for this PR, including any manual or automated tests conducted. Specify the testing environment and provide clear instructions for reviewers on how to reproduce the tests, if applicable. + +## Related issue(s)/PR(s) + +Let us know if this is related to any issue/pull request + +## Additional Notes + +Include any additional information or context that may be helpful for reviewers. diff --git a/README.md b/README.md index cac733a..212abf5 100644 --- a/README.md +++ b/README.md @@ -28,8 +28,8 @@ ```sh └── profanity.dev/ - ├── tensor-api # Hono server - ├── vector-api # Hono server + ├── tensor-api # Hono serverless api + ├── vector-api # Hono serverless api └── www # NextJs application ```