Skip to content

Latest commit

 

History

History
32 lines (18 loc) · 2.07 KB

CONTRIBUTING.md

File metadata and controls

32 lines (18 loc) · 2.07 KB
Raw

Contributing to Syntactik

Code of Conduct

This project and everyone participating in it is governed by the Syntactik Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

If you found a bug

  • Ensure the bug was not already reported by searching on GitHub under Issues.

  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

If you've created a patch that fixes a bug

  • Open a new GitHub pull request with the patch.

  • Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.

If you want to add a new feature or change an existing one

  • Create a new issue and tell about your feature or change.
  • Start writing code once you get positive feedback from the repository maintainers.

If you have questions about language, source code, command line tool or editor

Ask your question in chat: Join the chat at https://gitter.im/syntactik

Or create a topic in the google group Syntactik.

If you want to implement Syntactik for another language

Syntactik was designed to be easily converted to other languages. Look at this project https://github.com/MaximTrushin/SyntactikJs as example. This is a proof of concept project proves that it is possible to convert Syntactik parser to another language (in this case JavaScript) in matter of days by just converting language instructions one to one (like, for example, converting if statement in C# to if statement in JavaScript etc).