Skip to content

Latest commit

 

History

History
77 lines (44 loc) · 3.09 KB

CONTRIBUTING.md

File metadata and controls

77 lines (44 loc) · 3.09 KB
Raw

Guide to Contributing

We welcome pull requests from first-timers and seasoned veteran programmers alike. Follow these steps to contribute:

  1. Star the Repo ⭐ Click the 'Star' button in the top right!

  2. Find an issue to work with the tag 'first-timers-only', 'up-for-grabs', or 'help-wanted'. Or Raise a new issue

  3. Let us know you are working on the issue by commenting on it and assigning it to yourself. There is a bot that will automatically create a branch for you when you assign the issue to yourself. Also, please strive to submit your pull request within a week of claiming it in case someone else wants to do it. [1]

  4. Follow this Contribution guide and the Code of Conduct

If you need any help then checkout our gitter chatroom.

If you're new to open source or this is your first Pull Request - you can learn by reading the Official Github How to Contribute to Open Source Guide or watching the series How to Contribute to Open Source on Github

Getting Started

# Get the latest version
git clone [email protected]:esfiddle/site.git

# Change directory
cd site

# Project setup
yarn install

# Compiles and hot-reloads for development
yarn run serve

# Compiles and minifies for production
yarn run build

# Lints and fixes files
yarn run lint

# Run your unit tests
yarn run test:unit

Emoji Guide

We believe that emojis are fun and can be very helpful in quickly understanding changes and messages. We usually prepend emojis onto commit messages and PR messages. We try to follow a standard and here are the most common emojis and how they're used. If you don't want to use emjois in your messages, that's just fine.

Commit Messages

🚀 For commits related to adding new features.

🐛 For commits related to fixing broken code.

🔧 For commits that are just chores.

📝 For commits related to adding/maintaining documentation and the blog.

♻️ For commits related to refactoring code and making it better.

🔍 For commits related to writing or fixing tests.

🌈 For commits related to design and style changes.

Pull Request Messages

🚀 For PRs that are primarily new features or enhancements.

🐛 For PRs that are primarily bug fixes.

🔧 For PRs that are primarily chores.

Need Further Help

We are always willing to provide a helping hand, so please feel free to comment on issues for more information or you can also join us via gitter.

Footnotes

[1] - If you are unable to work on an issue that week but would still like to do it then let us know when you estimate you will be able to complete it. We don't mind this at all!