Thank you for your interest in contributing to the @scayle/changelog-formatter package!
Important: This Github repository is a read-only mirror that is automatically synced from our internal monorepo, which serves as the single source of truth.
Because of this setup, we are unable to merge Pull Requests created directly against this repository. Any changes merged here would be overwritten by our automated sync pipeline.
The best way to contribute is to open an Issue in this repository.
- Use the Issues tab to report bugs
- Include detailed information about:
- SDK version you're using
- Node.js version
- Steps to reproduce the issue
- Expected vs actual behavior
- Error messages or stack traces
- Propose new API endpoints or SDK improvements
- Suggest better TypeScript types or interfaces
- Request additional helper methods or utilities
- Share ideas for better developer experience
If you're willing to write code:
-
Create a Pull Request - We won't be able to merge it directly, but we can:
- Review your code implementation
- Provide feedback and suggestions
- Apply it as a patch to our internal repository
- Give you credit for the contribution
-
Follow our coding standards:
- Use TypeScript with strict type checking
- Write comprehensive tests for new functionality
- Follow our existing code style and patterns
- Update documentation as needed
- Improve README examples
- Add JSDoc comments for better IDE support
- Create usage examples or tutorials
- Fix typos or clarify confusing sections
- Be respectful and constructive in discussions
- Search existing issues before creating new ones
- Provide clear, detailed descriptions
- Help others when you can
We appreciate your understanding of our contribution process and thank you for
helping improve the @scayle/changelog-formatter package!