bekindprofanityfilter 0.0.1

package/CONTRIBUTORS.md

@@ -0,0 +1,106 @@
+# Contributors
+
+Welcome to the allProfanity project! We're excited to have you here and grateful for your interest in contributing to making profanity detection better for everyone.
+
+## Our Contributors
+
+Thank you to all the amazing people who have contributed to this project:
+
+<!-- Add your name below this line -->
+- Your Name (@your-github-username)
+<!-- Keep the list alphabetically sorted -->
+
+---
+
+## How to Contribute
+
+We welcome contributions of all kinds! Here are some ways you can help:
+
+- Add support for new languages
+- Improve existing word lists
+- Enhance detection algorithms
+- Fix bugs
+- Improve documentation
+- Add or improve test cases
+
+## Adding a New Language
+
+When adding support for a new language, please follow these important guidelines:
+
+### Required Steps:
+
+1. **Add the word list** for the new language in the appropriate location
+2. **Update the configuration** to include the new language
+3. **Write comprehensive test cases** for the new language
+   - Include tests for common profane words
+   - Include tests for edge cases
+   - Include tests for false positives (words that should NOT be flagged)
+4. **Run all tests** and ensure they pass
+5. **Take a screenshot** of the passing tests
+6. **Attach the screenshot** to your Pull Request
+
+### Example Test Structure:
+
+```typescript
+describe('Language: YourLanguage', () => {
+  it('should detect profanity', () => {
+    // Your test cases
+  });
+
+  it('should not flag clean words', () => {
+    // Your test cases
+  });
+});
+```
+
+## Pull Request Guidelines
+
+When submitting a Pull Request, please:
+
+1. **Provide a clear description** of what your PR does
+2. **Reference any related issues** (e.g., "Fixes #123")
+3. **Include test results** - attach a screenshot showing all tests passing
+4. **Follow the existing code style** and conventions
+5. **Keep changes focused** - one feature/fix per PR
+6. **Update documentation** if you're adding new features
+
+## Testing Your Changes
+
+Before submitting a PR:
+
+```bash
+# Install dependencies
+npm install
+
+# Run tests
+npm test
+
+# Run linting (if applicable)
+npm run lint
+
+# Build the project
+npm run build
+```
+
+Make sure all tests pass and take a screenshot to include in your PR!
+
+## Code of Conduct
+
+- Be respectful and inclusive
+- Provide constructive feedback
+- Help others learn and grow
+- Focus on what is best for the community
+
+## Questions or Need Help?
+
+- Open an issue for bugs or feature requests
+- Start a discussion for questions or ideas
+- Check existing issues and PRs before creating new ones
+
+## Recognition
+
+All contributors will be recognized in this file and in our release notes. Your contributions, no matter how small, are valuable and appreciated!
+
+---
+
+Thank you for making allProfanity better! 🎉

package/LICENSE

@@ -0,0 +1,22 @@
+# MIT License
+
+Copyright (c) 2025 Ayush Jadaun (original AllProfanity)
+Copyright (c) 2026 Grassroots Labs Org (be-kind-profanity-filter fork)
+
+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