Skip to content

Latest commit

 

History

History
47 lines (30 loc) · 2.68 KB

CONTRIBUTING.md

File metadata and controls

47 lines (30 loc) · 2.68 KB

Contributing to Pallas

Thanks for considering a contribution!

How to Contribute

Contributing without writing code

Pallas is a fairly unique project and not necessarily suited to contribution by the average engineer, but you can help us get in front of the right people:
Please consider starring this repository or sharing it with others. Particularly good matches will be those engineers who have experience with purely functional programming, exokernels/unikernels, runtime development, Urbit, systems programming, and related areas.

Reporting bugs

  1. Check for existing issues: Before you create a new issue, please search in our issues to see if the issue or feature request has already been filed.
  2. Create a new issue: If no existing issues fit your concern, create a new issue and provide detailed information, including steps to reproduce the problem.

Submitting new examples

If you have ideas for a new demo/example, please submit it as a new example issue

We will discuss it from there and invite you to submit a change (see below).

Documentation improvements

Our documentation lives in this repository. Please open a PR there if you'd like to suggested improvements, changes or corrections to the documentation

Questions / Clarifications

There are many novel concepts introduced by Pallas, and though we strive to provide helpful documentation and comments there will inevitably be questions and needed clarifications. Where possible, we'd like to document these answers somewhere the next person can find them.

  1. Search the documentation: Check the documentation site to see if your question is answered there.
  2. Search for existing questions: Search our issues for questions similar to the one you have.
  3. If you can't find anything, either submit a new question issue or ask on Telegram.

Submitting Changes

  1. Fork the repository: Create your own fork of the repository on GitHub.
  2. Create a new branch: Make your changes in a new branch in your forked repository.
  3. Run tests:
    • COMING SOON
  4. Submit a pull request: Once your changes are ready, submit a pull request from your branch to the master branch of the Pallas Repository

We appreciate every contribution!