Skip to content

Latest commit

 

History

History
98 lines (66 loc) · 3.58 KB

CONTRIBUTING.md

File metadata and controls

98 lines (66 loc) · 3.58 KB
Raw

Contributing

First off, thank you for taking the time to contribute to Open Web Organization ❤️

💭 Knowledge

TypeScript

It's important to note early on that this project is written with TypeScript. If you're unfamiliar with it or any strongly typed languages such as Java then this may be a slight roadblock. However, there's never a truly perfect time to start learning it, so ... why not today!

Architecture

An understanding of the library architecture and design will help if you're looking to contribute long-term, or you are working on a big PR. Browse the source and read our documentation to get a better idea on how it is structured. Feel free to ask any question, we would love to elaborate.

🎒 Getting Started

Install

Please view the README and the instructions below on how to install the project locally.

Project Setup

Working on your first Pull Request? You can learn how from this free series How to Contribute to an Open Source Project on GitHub.

Head over to the [repository][deep-unref] on GitHub and click the Fork button in the top right corner. After the project has been forked, run the following commands in your terminal:

# Replace {github-username} with your GitHub username.
$: git clone https://github.com/{github-username}/deep-unref-vue --depth=1

$: cd deep-unref-vue

# Create a branch for your PR, replace {issue-no} with the GitHub issue number.
$: git checkout -b issue-{issue-no}

Now it'll help if we keep our main branch pointing at the original repository and make pull requests from the forked branch.

# Add the original repository as a "remote" called "upstream".
$: git remote add upstream git@github.com:openweblabs/deep-unref-vue.git

# Fetch the git information from the remote.
$: git fetch upstream

# Set your local main branch to use the upstream main branch whenever you run `git pull`.
$: git branch --set-upstream-to=upstream/main main

# Run this when we want to update our version of main.
$: git pull

🧪 Test

Unit

Each of our Web Components comes with test cases. Feel free to check them out within the ./tests root folder. When adding or or updating functionality, please ensure it is covered through our tests and that the new tests pass by running pnpm test.

✍️ Commit

This project uses semantic commit messages to automate package releases. Simply refer to the link, and also see existing commits to get an idea of how to write your message.

# Add all changes to staging to be committed.
git add .

# Commit changes & follow the CLI prompts.
pnpm run commit

# Push changes up to GitHub
git push

🎉 Pull Request

When you're all done head over to the repository, and click the big green Compare & Pull Request button that should appear after you've pushed changes to your fork.

Don't expect your PR to be accepted immediately or even accepted at all. Give the community time to vet it and see if it should be merged. Please don't be disheartened if it's not accepted. Your contribution is appreciated more than you can imagine, and even a failed PR can teach us a lot ❤️