Skip to content

How to Contribute

Jump to bottom
Matias Ezequiel Vara Larsen edited this page Aug 30, 2021 · 6 revisions

Report a Bug

  • To report an issue please follow instructions in https://help.github.com/articles/creating-an-issue/,
  • Title of the issue must briefly describe the problem,
  • Body should detail what is the issue and how can be reproduced,
  • Attach the Toro image if it is possible,
  • Attach the code where is the issue if it is possible,
  • The issue will be reviewed by one of the maintainer.

Submission by email

  • Submit the unit/file you modified by mail as an attachment to torokernel@googlegroups.com,
  • Subject of the mail may contain the ticket number if it is a bug fix,
  • Body of the mail MUST explicitly approve that the attachment submitted does not contain any copyrighted content, no code coming from other open source project, the submitter MUST agree to have modified content by its own without copying from external resource,
  • Body of the mail MUST contain the standard ISC license granting all rights of the modifications supplied to the project owner ie: Toro Kernel,
  • Your submission (as a unit/file) MUST contain only a single patch/modification,
  • Your submission MUST NOT contain multiple patches/modifications, otherwise your submission will be rejected,
  • Your submission MUST BE based on the latest version (master) of the source tree,
  • Tests need to compile properly otherwise your submission will be rejected,

Submission by pull request

  • Submit a pull request from the development branch which has been forked from master,
  • Your submission may be split into several commits,
  • Commit(s) title(s) may contain the ticket number if it is a bug fix,
  • Commit body MUST describe the aim of the commit, in other words, write a meaningful commit message,
  • Tests need to compile properly otherwise your submission will be rejected, this is automated by relying on travis. You can check the status of the building of any branch.

General tips

  • Your submission will be reviewed and committed by one of the maintainers,
  • The whole project needs to pass coverage and no new regression should appear, otherwise your submission will be rejected,
  • This methodology offers you the expertise of core developers adapting your submission to be compliant with proper guidelines moreover this methodology provides you with the fastest way to get the most up-to-date whole source tree including your modification
  • Your patch, once merged, will be maintained as prime source by the core developers of TORO kernel.

Toro Code Syntax Style

Submission must follow the official Borland Object Pascal and Delphi syntax otherwise the submission will be rejected. More information about the code syntax style can be found in https://edn.embarcadero.com/article/10280.

Clone this wiki locally