toastdotdev/toast

CONTRIBUTING.md

Closed this issue · 3 comments

ChristopherBiscardi commented

Create a CONTRIBUTING file so people know how best to work with the repo, etc

talves commented

Something similiar to what Kent uses for now?

I could do a PR if you want to start here. Might need something more for rust (added simple).

Contributing

Thanks for being willing to contribute!

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

Project setup

  1. Fork and clone the repo
  2. Run yarn install to install dependencies
  3. Create a branch for your PR with git checkout -b pr/your-branch-name

Tip: Keep your master branch pointing at the original repository and make
pull requests from branches on your fork. To do this, run:

git remote add upstream https://github.com/toastdotdev/toast.git
git fetch upstream
git branch --set-upstream-to=upstream/main main

This will add the original repository as a "remote" called "upstream," Then
fetch the git information from that remote, then set your local master
branch to use the upstream main branch whenever you run git pull. Then you
can make all of your pull request branches based on this main branch.
Whenever you want to update your version of main, do a regular git pull.

Rust setup

If you're going to help with the rust code you'll need Rust installed and cargo (Rust's build tool) on your local dev machine.

Test installs with the following commands:

rustc --version
cargo --version

Help needed

Please checkout the the open issues

Also, please watch the repo and respond to questions/bug reports/feature requests! Thanks!

ChristopherBiscardi commented

@talves Feel free to kick off a PR. We can discuss and make changes there.

  • 👍1