CONTRIBUTING.md

Contributing

We'd love to accept your contributions to this project!

There are just a few guidelines you need to follow.

Bugs

Bug reports should be opened up as issues on the go-vela/community repository!

Feature Requests

Feature Requests should be opened up as issues on the go-vela/community repository!

Pull Requests

NOTE: We recommend you start by opening a new issue describing the bug or feature you're intending to fix. Even if you think it's relatively minor, it's helpful to know what people are working on.

We are always open to new PRs! You can follow the below guide for learning how you can contribute to the project!

Getting Started

Prerequisites

• Review the commit guide we follow - ensure your commits follow our standards
• Review the local development docs - ensures you have the Vela application stack running locally

Setup

• Fork this repository

• Clone this repository to your workstation:

# clone the project
git clone [email protected]:go-vela/ui.git $HOME/go-vela/ui

• Navigate to the repository code:

# change into the cloned project directory
cd $HOME/go-vela/ui

• Point the original code at your fork:

# add a remote branch pointing to your fork
git remote add fork https://github.com/your_fork/ui

Development

Please review the local development documentation for more information.

• Navigate to the repository code:

# change into the cloned project directory
cd $HOME/go-vela/ui

• Write your code and tests to implement the changes you desire.

  • Please be sure to follow our commit rules

• Run the repository code (ensures your changes perform as you desire):

# execute the `up` target with `make`
make up

• Test the repository code (ensures your changes don't break existing functionality):

# execute the `test` target with `make`
make test

# execute the `test-cypress` target with `make`
make test-cypress

• (Optional) Analyze the repository code (ensures your code follows best practices):

# analyze the code to see if anything isn't following recommended guidelines
elm-analyse --serve

# navigate to http://localhost:3000 to view analyze results
open http://localhost:3000

• Lint the repository code (ensures your code meets the project standards):

# capture a list of issues found by the linter
npm run lint

# if any issues are present, attempt to fix them automatically
npm run lint:fix

• Push to your fork:

# push your code up to your fork
git push fork main

• Open a pull request. Thank you for your contribution!

Tips

Visual Studio Code Users

• Check out the Elm extension by Elm tooling (elmtooling.elm-ls-vscode). It will help make elm-format and elm-analyse and automatic thing and provide other niceties.

• Enable the stylelint extension - you might want to check their readme for some pointers with issues you might run into.

• Enable the Prettier extension

IntelliJ Users

• There is a great Elm plugin by Keith Lazuka, made by a few people at Microsoft, for IntelliJ available.

Vim Users

• These are the most referenced plugins for Vim, your milage may vary:

  • elm-tooling/elm-vim
  • ElmCast/elm-vim
  • prettier/vim-prettier
  • dense-analysis/ale (supports stylelint)

Credit

The project setup is loosely based on Elm Batteries. Learn more at the Elm Batteries Documentation