Skip to content

Latest commit

 

History

History
59 lines (37 loc) · 1.16 KB

CONTRIBUTING.md

File metadata and controls

59 lines (37 loc) · 1.16 KB
Raw

🌍 Contributing.

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

👶 Getting Started!

Ready to contribute? Here's how to set up code-inbox for local development.

  1. Fork the code-inbox repo on GitHub.
  2. Clone your fork locally:
git clone git@github.com:your_name_here/code-inbox.git
  1. Navigate to the recently created directory:
cd code-inbox
  1. Install the main dependencies:
pnpm install
  1. Create a branch for local development:
git checkout -b name-of-your-bugfix-or-feature
  1. Set the following env variables:
export VITE_SERVER_URL=http://localhost:8000/api/v1

Now you can make your changes locally.

  1. Commit your changes and push your branch to GitHub:
git add .
git commit -m "Your detailed description of your changes."
git push origin name-of-your-bugfix-or-feature
  1. Submit a pull request through the GitHub website.

📙 Pull Request Guidelines.

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request should include tests, if applicable.

Thank you for helping us improve!