Skip to content

Latest commit

 

History

History
101 lines (70 loc) · 3.88 KB

CONTRIBUTING_GUIDE.md

File metadata and controls

101 lines (70 loc) · 3.88 KB
Raw

Table of Contents

How to contribute

First of all, thank you for taking the time to contribute to this project. 🎉🎉🎉 We've tried to make a stable project and try to fix bugs and add new features continuously. You can help us do more.

Before you start, read the README.md file for info on the project and how to set it up.

Finding first issue

Go to issues tab and look for

✏️ good first issue - it is a label for tasks that are perfect for people who want to start with Lisk.

Reporting issues

  1. Check if problem already exist in issues tab
  2. If not, create a new issue
  3. Fill our template
  4. Click Submit new issue
Guidance
  • Include screenshots or animated GIF
  • Use a clear and descriptive title
  • Provide OS and browser version
Example

Alt text

❗ Issues created that are not relevant to this project will be closed immediately.

Writing some code!

Contributing to a project on Github is pretty straight forward. If this is you're first time, these are the steps you should take.

  • Fork this repo.

And that's it! Read the code available and apply your changes according to the issue you're working on! You're change should not break the existing code and should pass the tests.

Start from the branch that matches issue version ex. 0.5.0 If there is no issue version start from development. git checkout development Create a new branch under the name of the issue and work in there. Remember about branch naming convention [issue number]-ticket-description ex. git checkout -b 123-create-docs

Creating commits

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally after the first line
  • Consider starting the commit message with an applicable emoji:
    • 🌱 :seedling: when adding a new feature
    • 🐛 :bug: when fixing a bug
    • 📚 :books: when adding or updating documentation
    • 💅 :nail_care: when making changes to code style (e.g. lint settings)
    • ♻️ :recycle: when refactoring code
    • 🔥 :fire: when removing code or files (including dependencies)
    • 🐎 :racehorse: when improving performance
    • ✅ :white_check_mark: when adding or updating tests
    • 👷 :construction_worker: when updating the build process
    • :bowtie: :bowtie: when updating CI
    • 🏠 :house: when performing chores
    • 🆕 :new: when adding a new dependency
    • ⬆️ :arrow_up: when upgrading a dependency
    • ⬇️ :arrow_down: when downgrading a dependency
    • 🔙 :back: when reverting changes
Guidance
  • Please use rebase instead of merge for resolving conflicts
  • Make sure that Jenkins build passes
  • Remember to delete branch after successfully merging the PR.
Example

Alt text

Creating branch

We use naming convention [issue number]-[what-the-ticket-is-about]. :heavy*exclamation_mark: Remember to use - instead of *. ex. 12-create-new-sign-in-template

Tests

We've written tests and you can run them to assure the stability of the code, just try running npm run test-live. If you're adding a new functionality please include tests for it.