Skip to content

docs: 📝 update test coverage info and friendly discussion text #110

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
mandy8055 wants to merge 1 commit into from
Closed

docs: 📝 update test coverage info and friendly discussion text #110

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions .github/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,6 @@ Branch naming convention:
```

5. Update documentation:

- Update JSDoc comments
- Update relevant markdown files
- Update examples if needed
Expand Down Expand Up @@ -100,7 +99,7 @@ Follow [Conventional Commits](https://www.conventionalcommits.org/)
### Testing

- Write unit tests for all new features
- Maintain test coverage above 85%
- Maintain test coverage above 95%
- Include edge cases in tests
- Use descriptive test names

Expand Down
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,15 +54,15 @@ console.log(cache.get('key')); // 42
- 🎯 **Type Safety** - Full TypeScript support with generics
- 📦 **Zero Dependencies** - Lightweight and secure
- ⚡ **Performance** - Optimized implementations with documented time complexities
- 🧪 **Well Tested** - Comprehensive test coverage (>85%)
- 🧪 **Well Tested** - Comprehensive test coverage (~100%)
- 🌲 **Tree Shakeable** - Import only what you need
- 🔄 **Dual Published** - Available on both JSR and npm

## Links

- 📚 **[Documentation](https://data-structures-docs.vercel.app)** - Complete guides and API reference
- 🐛 **[Issues](https://github.com/mandy8055/data-structures/issues)** - Report bugs or request features
- 💬 **[Discussions](https://github.com/mandy8055/data-structures/discussions)** - Join the community
- 💬 **[Discussions](https://github.com/mandy8055/data-structures/discussions)** - Have Idea! Let's discuss

## License

Expand Down
4 changes: 2 additions & 2 deletions website/docs/intro.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ A comprehensive collection of type-safe, zero-dependency data structure implemen
- **🎯 Type Safety**: Full TypeScript support with generics for complete type safety
- **📦 Zero Dependencies**: No external dependencies - lightweight and secure
- **⚡ Performance**: Optimized implementations with documented time complexities
- **🧪 Well Tested**: Comprehensive test coverage (>85%)
- **🧪 Well Tested**: Comprehensive test coverage (~100%)
- **🌲 Tree Shakeable**: Import only what you need - minimal bundle impact
- **📚 Well Documented**: Extensive documentation with examples
- **🔄 Dual Published**: Available on both JSR and npm for maximum compatibility
Expand Down Expand Up @@ -99,7 +99,7 @@ console.log(cache.get('key')); // 42

- **GitHub**: [mandy8055/data-structures](https://github.com/mandy8055/data-structures)
- **Issues**: [Report bugs or request features](https://github.com/mandy8055/data-structures/issues)
- **Discussions**: [Join the community](https://github.com/mandy8055/data-structures/discussions)
- **Discussions**: [Have idea! Let's discuss](https://github.com/mandy8055/data-structures/discussions)

## License

Expand Down
4 changes: 2 additions & 2 deletions website/i18n/de/docusaurus-plugin-content-docs/current/intro.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Eine umfassende Sammlung typsicherer, abhängigkeitsfreier Datenstruktur-Impleme
- **🎯 Typsicherheit**: Vollständige TypeScript-Unterstützung mit Generics für vollständige Typsicherheit
- **📦 Null Abhängigkeiten**: Keine externen Abhängigkeiten - leichtgewichtig und sicher
- **⚡ Performance**: Optimierte Implementierungen mit dokumentierten Zeitkomplexitäten
- **🧪 Gut getestet**: Umfassende Testabdeckung (>85%)
- **🧪 Gut getestet**: Umfassende Testabdeckung (~100%)
- **🌲 Tree Shakeable**: Importieren Sie nur, was Sie brauchen - minimale Bundle-Auswirkung
- **📚 Gut dokumentiert**: Umfangreiche Dokumentation mit Beispielen
- **🔄 Dual veröffentlicht**: Verfügbar auf JSR und npm für maximale Kompatibilität
Expand Down Expand Up @@ -99,7 +99,7 @@ console.log(cache.get('key')); // 42

- **GitHub**: [mandy8055/data-structures](https://github.com/mandy8055/data-structures)
- **Issues**: [Fehler melden oder Features anfordern](https://github.com/mandy8055/data-structures/issues)
- **Discussions**: [Treten Sie der Community bei](https://github.com/mandy8055/data-structures/discussions)
- **Discussions**: [Ich habe eine Idee! Lass uns darüber reden](https://github.com/mandy8055/data-structures/discussions)

## Lizenz

Expand Down
4 changes: 2 additions & 2 deletions website/i18n/zh-CN/docusaurus-plugin-content-docs/current/intro.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ sidebar_position: 1
- **🎯 类型安全**：完整的 TypeScript 支持，带有泛型，提供完全的类型安全
- **📦 零依赖**：无外部依赖 - 轻量且安全
- **⚡ 高性能**：经过优化的实现，并附有时间复杂度文档
- **🧪 经过充分测试**：全面的测试覆盖率 (>85%)
- **🧪 经过充分测试**：全面的测试覆盖率 (~100%)
- **🌲 可 Tree Shake**：只导入您需要的部分 - 最小化打包影响
- **📚 文档齐全**：提供大量示例的详细文档
- **🔄 双重发布**：在 JSR 和 npm 上均可用，实现最大兼容性
Expand Down Expand Up @@ -99,7 +99,7 @@ console.log(cache.get('key')); // 42

- **GitHub**: [mandy8055/data-structures](https://github.com/mandy8055/data-structures)
- **问题反馈**: [报告错误或请求功能](https://github.com/mandy8055/data-structures/issues)
- **讨论**: [加入社区](https://github.com/mandy8055/data-structures/discussions)
- **讨论**: [有想法了？欢迎一起!](https://github.com/mandy8055/data-structures/discussions)

## 许可证

Expand Down
Loading