![]() |
![]()
| ![]() |
![]()
NAMEData::Sah::Manual::Contributing - Contributing to Data::Sah VERSIONThis document describes version 0.917 of Data::Sah::Manual::Contributing (from Perl distribution Data-Sah), released on 2024-02-16. DESCRIPTIONThis document explains how to contribute to Data::Sah developments. To contribute, you can send a pull request on GitHub, or contact me personally. Thanks for contributing. IMPLEMENTINGImplementing clausesSome clauses are not yet implemented. If you are interested in helping out implementing these, you can first find the list of not-yet-implemented clauses from the main Data::Sah POD, or from "t/spectest-perl.t" or "t/spectest-js.t". You should first uncomment the clause in "t/spectest-perl.t" or "t/spectest-js.t" so that the to-be-implemented clause can be tested. You should take a look at another implemented clause in Data::Sah::Compiler::perl::TH::$TYPE, Data::Sah::Compiler::js::TH::$TYPE, Data::Sah::Compiler::human::TH::$TYPE for example. You'll need to implement the clause in all of these compilers, for completeness. But it is okay if you leave out some compilers, I and others will try to help implementing it for you. You should also update "Data::Sah" POD (the Status section) to let users know that the clause has been implemented. Implementing other aspectsFor example: functions, expression, subschema, etc. Please contact me personally to discuss things first. CREATING TRANSLATIONTranslations are put in Data::Sah::Lang::$LANGCODE. Since I am Indonesian, language "id_ID" is the most complete. You can use the utility "devscripts/list-missing-translations" to list which translation strings are missing between "id_ID" and your target language. WRITING TUTORIAL/DOCUMENTATIONTutorials should be put in "Data::Sah::Manual::Tutorial". Cookbook-type documentation are also welcome, they should be put in "Data::Sah::Manual::Cookbook" or "Data::Sah::Manual::Cookbook::*". EXTENDINGData::Sah is created with extension in mind. You can create new types, add clauses to existing types, or create a schema that can be shared for others. Please see Data::Sah::Manual::Extending for more details. The extensions can be packaged in separate distributions, so you can release them independently of Data::Sah. HOMEPAGEPlease visit the project's homepage at <https://metacpan.org/release/Data-Sah>. SOURCESource repository is at <https://github.com/perlancar/perl-Data-Sah>. AUTHORperlancar <perlancar@cpan.org> CONTRIBUTINGTo contribute, you can send patches by email/via RT, or send pull requests on GitHub. Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via: % prove -l If you want to build the distribution (e.g. to try to install it locally on your system), you can install Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, Pod::Weaver::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla- and/or Pod::Weaver plugins. Any additional steps required beyond that are considered a bug and can be reported to me. COPYRIGHT AND LICENSEThis software is copyright (c) 2024, 2022, 2021, 2020, 2019, 2018, 2017, 2016, 2015, 2014, 2013, 2012 by perlancar <perlancar@cpan.org>. This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. BUGSPlease report any bugs or feature requests on the bugtracker website <https://rt.cpan.org/Public/Dist/Display.html?Name=Data-Sah> When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.
|