Skip to content

Fix incorrect clone instructions and dev branch reference in README #82

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
LJitendra05 wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Fix incorrect clone instructions and dev branch reference in README #82

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d7bc4a3
Fix README clone instructions referencing non-existent dev branch and…
LJitendra05 Feb 23, 2026
eb6a81f
Fix project name capitalization: coastline-extraction → CoastlineExtr…
LJitendra05 Mar 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 13 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,15 @@ Before installing this project, ensure you have the following requirements:

### Clone the Repository

Clone the project using the `dev` branch (this branch contains the latest development features):
Clone the project using the default `master` branch:

```bash
git clone -b dev https://github.com/your-username/coastline-extraction.git
cd coastline-extraction
git clone https://github.com/fwitmer/CoastlineExtraction.git
cd CoastlineExtraction
```

> ⚠️ Note: The repository currently contains only the `master` branch. Earlier versions of this README referenced a non-existent `dev` branch and an incorrect repository URL (`coastlineExtraction.git`), which caused cloning to fail for new users.

---

### Environment Setup
Expand Down Expand Up @@ -124,20 +126,22 @@ shapefile_path = get_shapefile_path(config, 0) # First shapefile

## Contributing

### Working with the Dev Branch
### Contribution Workflow

This project currently uses the `master` branch as the primary development branch.

This project uses the `dev` branch for active development. When contributing:
When contributing:

1. **Fork the repository on GitHub**

2. **Clone your fork using the `dev` branch**:
2. **Clone your fork**:

```bash
git clone -b dev https://github.com/your-username/coastline-extraction.git
cd coastline-extraction
git clone https://github.com/your-username/CoastlineExtraction.git
cd CoastlineExtraction
```

3. **Create a feature branch from `dev`**:
3. **Create a feature branch from `master`**:

```bash
git checkout -b feature/your-feature-name
Expand Down