Contribution - amirkarimi/Xoqal GitHub Wiki

Many thanks for your interest in contributing to Xoqal. There are just some points that you should know before contributing:

Coding Style

Follow StyleCop rules except for documentation. We omit documentation rules for now and will added those rules after completing Xoqal XML documentation. As we are working on documentation we don't accept pull requests without XML comments.

StyleCop build integration is used to avoid unreadable or dirty code. So the Xoqal solution won't be built unless the specified StyleCop rules are met.

There is a Settings.StyleCop file at Source folder root which applies the specified exceptions.

Commit Comments

Please consider following principals when you're committing a work:

• Use past tense.
• Use a short title as commit message. You can extend it as description while commit description is optional.
• Don't forget to put period at the end.
• Use - or * to specify unordered list of works.
• Explain about your works as much as you can.
• It's encouraged to have multiple commits with small changes instead of a single commit with many changes.

Example:

Added SomethingMagic class to make developers happy.
- Removed extra codes from Foo.
- Updated Bar to support Foo.
- Improved Foo performance.
- Removed BlahBlah because it was ...

Fork Xoqal now!