Skip to content

Latest commit

 

History

History
33 lines (29 loc) · 1.25 KB

CONTRIBUTING.md

File metadata and controls

33 lines (29 loc) · 1.25 KB
Raw

Contributing to Crana

Thank you for considering to contribute to Crana! Together we can make crana the best tool of its kind. But we need YOU to make that happen!

As an inspiration, you can have a look at the Roadmap section of this page. But any other contribution is also welcome, the roadmap below just contains some ideas where you could start. It would even be a very helpful contribution if you added something to the roadmap!

Roadmap

  • Improve documentation
  • Improve contribution guide
    • Issue template
    • ...any ideas?
  • Create a simple website
  • Developers should be able to customize every aspect of crana (directly customizing configurations per project)
  • Implement sort of a plugin system
  • Add deployment automations + deployment guides
  • Open an issue/start a pull request if you have more ideas!

Development environment

Getting started with development is really straight forward:

  • Step 1: Clone the repository 
    git clone https://github.com/scriptify/crana.git
  • Step 2: Install the dependencies 
    npm i
  • Step 3: Create a symlink to the package, so you can use it directly in your CLI. 
    npm link
  • Step 4: Start hacking!