From f64803ad035cf2f98749d1f8b9da703ed1abf115 Mon Sep 17 00:00:00 2001 From: Zoey de Souza Pessanha Date: Tue, 18 Jun 2024 13:42:36 -0300 Subject: [PATCH] write issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 27 ++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 +++++++ .github/pull_request_template.md | 23 ++++++++ CHANGELOG.md | 66 +++++++++++++++++++++++ 4 files changed, 136 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/pull_request_template.md create mode 100644 CHANGELOG.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..a7021e1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,27 @@ +--- +name: Bug report +about: Create a report to help us improve +title: "[BUG]" +labels: bug +assignees: zoedsoupe + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Environment** + • Elixir version: [e.g., 1.16.0] + • Peri version: [e.g., 0.2.3] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..df1a637 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: "[FEATURE]" +labels: enhancement +assignees: zoedsoupe + +--- + +**Description** +A clear and concise description of what you want to happen. + +**Motivation** +Explain why this feature is important or how it would improve Peri. + +**Alternatives** +Describe any alternative solutions or features you’ve considered. + +**Additional Context** +Add any other context or screenshots about the feature request here. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..dc24a9f --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,23 @@ +**Description** +A clear and concise description of what changes are being made and why. + +**Related Issues** +Link to any related issues or pull requests. + +**Type of Change** +- [ ] Bug fix +- [ ] New feature +- [ ] Breaking change +- [ ] Documentation update + +**Checklist** +- [ ] My code follows the style guidelines of this project. +- [ ] I have performed a self-review of my code. +- [ ] I have commented on my code, particularly in hard-to-understand areas. +- [ ] I have made corresponding changes to the documentation. +- [ ] My changes generate no new warnings. +- [ ] I have added tests that prove my fix is effective or that my feature works. +- [ ] New and existing unit tests pass locally with my changes. + +**Additional Context** +Add any other context or screenshots about the pull request here. diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..a03ec18 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,66 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +## [0.2.3] - 2024-06-18 + +### Added +- Implemented schema validation, bang functions, and improved error inspection. [fc061f0] + +### Fixed +- Improved error handling and inspecting. [f4d504b, afb054e] + +## [0.2.2] - 2024-06-17 + +### Added +- Native support for keyword lists. [9f8aaef] +- `conforms?/1` function. [9a39ed8] + +## [0.2.1] - 2024-06-16 + +### Added +- Continuous Integration (CI) setup. [16cf116] + +### Fixed +- Corrected mix.exs file for hex package. [af5a744] + +## [0.2.0] - 2024-06-15 + +### Added +- Enhanced error handling features. [f4d504b, afb054e] + +### Fixed +- Documentation updates in README and Hex docs. [4fd48ce] + +## [0.1.4] - 2024-06-10 + +### Added +- Support for `any`, `atom`, `oneof`, and `either` types. [6a225f4] + +## [0.1.2] - 2024-06-05 + +### Added +- Removed unknown fields from schema validation. [3fa79d4] +- Allowed custom, composable, and recursive schemas. [fd1f593] + +### Fixed +- Support for string map keys. [1b6edef] + +## [0.1.1] - 2024-06-02 + +### Added +- Support for `tuple`, `lists`, `enum`, and custom types. [7766adc] + +## [0.1.0] - 2024-06-01 + +### Added +- Initial version of Peri with basic schema validation functionalities. [7044ea7] + +[0.2.3]: https://github.com/zoedsoupe/peri/compare/v0.2.2...v0.2.3 +[0.2.2]: https://github.com/zoedsoupe/peri/compare/v0.2.1...v0.2.2 +[0.2.1]: https://github.com/zoedsoupe/peri/compare/v0.2.0...v0.2.1 +[0.2.0]: https://github.com/zoedsoupe/peri/compare/v0.1.4...v0.2.0 +[0.1.4]: https://github.com/zoedsoupe/peri/compare/v0.1.2...v0.1.4 +[0.1.2]: https://github.com/zoedsoupe/peri/compare/v0.1.1...v0.1.2 +[0.1.1]: https://github.com/zoedsoupe/peri/compare/v0.1.0...v0.1.1 +[0.1.0]: https://github.com/zoedsoupe/peri/releases/tag/v0.1.0