Before you begin –
- Install the latest stable version of Deno
- Install velociraptor
- VSCode is recommended, with a Deno workspace initialized
Pull all dependencies while also checking integrity with the command –
vr install
If you are adding or upgrading dependencies, please ensure you update the
lock.json
file with the command –
vr reload
To run all tests, run the command –
vr test
Before you make your changes, check to see if an issue exists already for the change you want to make.
If you spot something new, open an issue using a template. We'll use the issue to have a conversation about the problem you want to fix.
Fork using GitHub Desktop:
- Getting started with GitHub Desktop will guide you through setting up Desktop.
- Once Desktop is set up, you can use it to fork the repo!
Fork using the command line:
- Fork the repo so that you can make your changes without affecting the original project until you're ready to merge them.
Fork with GitHub Codespaces:
- Fork, edit, and preview using GitHub Codespaces without having to install and run the project locally.
Make your changes to the file(s) you'd like to update.
- Are you making changes to the application code? You'll need Deno v1.17+ to run the tests locally.
- Are you contributing to markdown? We use GitHub Markdown.
- Writing a Git commit message? We use the Angular commit convention.
When you're done making changes and you'd like to propose them for review, use the pull request template to open your PR (pull request).
- Once you submit your PR, project members will review it with you. The first thing you're going to want to do is a self review.
- After that, we may have questions, check back on your PR to keep up with the conversation.
- Did you have an issue, like a merge conflict? Check out GitHub's git tutorial on how to resolve merge conflicts and other issues.
Congratulations! OSlash and the whole open-source community thanks you. :sparkles:
Once your PR is merged, you will be proudly listed as a contributor in the contributor chart.