cryptia/CONTRIBUTING.md

Cryptia is a simple JavaScript library for encrypting and decrypting text using a basic substitution cipher. It provides an easy-to-use interface for securing text data in client-side applications..

# Cryptia

**_Cryptia_** is a simple JavaScript library for encrypting and decrypting text using a basic substitution cipher. It provides an easy-to-use interface for securing text data in client-side applications..

## How to contribute to Cryptia

## Fork the Repository

- Go to the **Cryptia GitHub repository** and click **Fork** to create a copy of the repo under your GitHub account.

## Clone Your Fork

- Clone the forked repo to your local machine:

  ```bash
  git clone https://github.com/{{ your git handle }}/cryptia.git
  ```

## Create a New Branch

- Always create a new branch for your changes:

  ```bash
  git checkout -b your-branch-name
  ```

## Make Changes

- Edit the code as needed.

## Commit Your Changes

- Stage and commit your changes:

  ```bash
  git add .
  git commit -m "Your commit message"
  ```

## Set Upstream for New Branch (if needed)

- If Git complains about no upstream branch, set it:

  ```bash
  git push --set-upstream origin your-branch-name
  ```

## Push Changes to Your Fork

- Push your branch to your fork:

  ```bash
  git push origin your-branch-name
  ```

## Create a Pull Request (PR)

- Go to the original **Cryptia repository** on GitHub.
- Click **New Pull Request** and select your branch.
- Add a clear title and description for your PR.
- Submit the PR.

## Address Feedback (if any)

- Respond to any review comments and make changes as requested.
- Push additional changes to the same branch.

---

### Key Git Commands

- `git remote add origin <your-fork-url>`: Link your local repo to your fork.
- `git remote -v`: Verify your remotes.
- `git checkout -b branch-name`: Create and switch to a new branch.
- `git push --set-upstream origin branch-name`: Push your branch and set upstream.

---

Happy Contributing! 🥂