Valid Features

AI Contribution Policy

No direct contributions from any AI system, generative or otherwise are allowed. No contributions with AI co-authors listed in the Cargo file or elsewhere will be accepted.

Potential contributors may make submissions which were created, whole or in-part, with AI tools as long as the author or authors, understands exactly what the submission does (in the case of a submission that includes code), how the submission works (again, in the case of a submission that includes code) and how it contributes to the project and the meaning of all the parts, components, text etc of the submission.

Submissions that include AI generated code must also include passing tests.

The maintainer or maintainers of the project and any sub-projects reserve the right to reject submissions made by potential and past contributors for any reason, including no reason.

Todo

• Add more documentation
• Add code examples
• Clean-up the code

Coding Style

This project uses a coding style that emphasises the use of white space over keeping the line and column counts as low as possible.

So this:

fn bar()
{
} 

fn foo()
{

    bar();

}

Not this:

fn bar(){} 

fn foo()
{
    bar();
}

License

Licensed under either of:

• Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0 (see also: https://www.tldrlegal.com/license/apache-license-2-0-apache-2-0))
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT (see also: https://www.tldrlegal.com/license/mit-license))

at your discretion

Contributing

Please clone the repository and create an issue explaining what feature or features you'd like to add or bug or bugs you'd like to fix and perhaps how you intend to implement these additions or fixes. Try to include details though it doesn't need to be exhaustive and we'll take it from there (dependant on availability).

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.