perlancar > Data-Sah-0.61 > Data::Sah::Manual::Contributing

Download:
Data-Sah-0.61.tar.gz

Annotate this POD

Website

CPAN RT

Open  1
View/Report Bugs
Source  

NAME ^

Data::Sah::Manual::Contributing - Contributing to Data::Sah

VERSION ^

This document describes version 0.61 of Data::Sah::Manual::Contributing (from Perl distribution Data-Sah), released on 2015-05-26.

DESCRIPTION ^

This 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.

IMPLEMENTING ^

Implementing clauses

Some 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 aspects

For example: functions, expression, subschema, etc. Please contact me personally to discuss things first.

CREATING TRANSLATION

Translations 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/DOCUMENTATION

Tutorials 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::*.

EXTENDING

Data::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.

HOMEPAGE ^

Please visit the project's homepage at https://metacpan.org/release/Data-Sah.

SOURCE ^

Source repository is at https://github.com/perlancar/perl-Data-Sah.

BUGS ^

Please 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.

AUTHOR ^

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2015 by 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.

syntax highlighting: