Skip to content

Latest commit

 

History

History
121 lines (81 loc) · 3.7 KB

CONTRIBUTING.md

File metadata and controls

121 lines (81 loc) · 3.7 KB

How to Contribute

Thank you for having interest in this repository. You may come to this page to know how you can fix your inconvenience. To contribute/improve codes of Haskell parts of this project, please follow step A. To contribute/improve codes of C/LLVM parts of this project, please follow step B.

Step A: For Haskell

0. Prerequisites

To download and build the haskell codes in this project completely, you need the following commands/tools.

However, if you want to change only a part of this project, you may not need all of these. More specifically,

  • All packages other than minicute-llvm-generator and minicute-minicute-compiler These packages do not require llvm (including llc and opt).
  • minicute-llvm-generator and minicute-minicute-compiler These packages require all of those tools.

1. Download this Project

You can download this repository using git.

git clone https://github.com/CUTE-Lang/miniCUTE.git
cd miniCUTE

2. Compile and Test this Project

To compile and to test this project, we recommend using stack.

After installing stack, use the following commands to compile this project,

stack build                        # To bulid all packages (require LLVM)
stack build minicute-common-syntax # To build minicute-common-syntax only

and use the next commands to test this.

stack test                        # To test all packages (require LLVM)
stack test minicute-common-syntax # To test minicute-common-syntax only

When you change codes, please check whether your patches are compiled and pass the tests.

3. Fork this Repository and Make a PR

After making changes, you may want to share your modifications. To share it on this repository, you need to make a PR.

To make a PR,

  1. Fork this repository with "Fork" button.
  2. Push your changes to your forked repository via git.
  3. Go to "Pull requests" tab of this repository.
  4. Click "New pull request" button.
  5. Click "compare across forks" text.
  6. Choose your forked repository and your updated branch.
  7. Click "Preview" tab to select template.
  8. Choose an appropriate template.
  9. Fill the form you get.
  10. Click "Create pull request".

After making a PR, we will review your PR.

Again, thank you for paying attention to this project!

Step B: For C/LLVM

0. Prerequisites

To download and build the C codes in this project completely, you need the following commands/tools.

1. Download this Project

You can download this repository using git.

git clone https://github.com/CUTE-Lang/miniCUTE.git
cd miniCUTE

2. Compile this Project

To build the C parts, use the following commands in the runtime directory of cloned directory.

make

3. Fork this Repository and Make a PR

After making changes, you may want to share your modifications. To share it on this repository, you need to make a PR.

To make a PR,

  1. Fork this repository with "Fork" button.
  2. Push your changes to your forked repository via git.
  3. Go to "Pull requests" tab of this repository.
  4. Click "New pull request" button.
  5. Click "compare across forks" text.
  6. Choose your forked repository and your updated branch.
  7. Click "Preview" tab to select template.
  8. Choose an appropriate template.
  9. Fill the form you get.
  10. Click "Create pull request".

After making a PR, we will review your PR.

Again, thank you for paying attention to this project!