Skip to content

Latest commit

 

History

History
148 lines (110 loc) · 3.44 KB

CONTRIBUTING.md

File metadata and controls

148 lines (110 loc) · 3.44 KB

Contribute to the Calvinist Parrot project

How to set up the project

Prerequisites

You will need to have the following installed on your machine:

  • Node.js 18.18.0 or higher
  • npm (comes with Node.js)
  • Git

Environment Setup

  1. Clone the repository

    git clone https://github.com/YOUR_USERNAME/calvinist-parrot.git
cd calvinist-parrot

  2. Install dependencies

    npm install

  3. Environment variables Copy the .env.template file to .env and fill in the required values. Contact the maintainers for required credentials and API keys.

  4. Run the development server

    npm run dev

Development Workflow

  1. Run tests (I need help adding tests)

    npm test

  2. Build the project

    npm run build

Contributing to the Project

Before you begin, fork the project on GitHub: Project Page

Contributing to the Project

Before you begin, make sure to fork the project. Go to the project's GitHub page and click the fork button: Project Page

Setting Up Your Local Repository

  1. Clone your forked repository to your local machine:

    git clone https://github.com/YOUR_USERNAME/calvinist-parrot.git
cd calvinist-parrot

  2. Add the original repository as a remote to pull future updates:

    git remote add upstream https://github.com/Jegama/calvinist-parrot.git

  3. Fetch the latest updates from the original repository:

    git fetch upstream

  4. Create a new branch for your changes:

    git checkout -b mychange upstream/master

Making Changes

  1. Make your changes to the code.

  2. Commit your changes:

    git add .
git commit -m "Describe your changes here"

Submitting Changes

  1. Push your changes to your fork:

    git push origin mychange

  2. Go to your fork on GitHub. You should see a Compare & pull request button. Click it to create a pull request.

    • When creating the pull request, you can choose to allow maintainers to make edits. This is helpful if they need to make minor adjustments before merging.

Updating Your Branch

If you need to make more changes after your initial commit:

  1. Make the changes locally.

  2. Amend your previous commit if you want to keep it as a single commit (optional):

    git add .
git commit --amend --no-edit

  3. Force push your changes (since you've amended the commit):

    git push -f origin mychange

Keeping Your Fork Updated

To keep your fork up to date with the original repository:

  1. Fetch updates from the upstream:

    git fetch upstream

  2. Merge updates into your master branch:

    git checkout master
git merge upstream/master

  3. Push updates to your fork:

    git push origin master

Note: It’s important to regularly sync your fork, especially before starting a new change.

Code Style Guidelines

  • Use TypeScript for all new code
  • Follow the existing code style
  • Use ESLint and Prettier for code formatting
  • Write tests for new features
  • Update documentation when needed

Need Help?

If you need help with anything, feel free to:

  • Open an issue
  • Ask questions in pull requests
  • Contact the maintainers

Thank you for contributing!