Skip to content

Commit

Permalink
docs: don't fork us (#564)
Browse files Browse the repository at this point in the history
  • Loading branch information
NoamGaash authored Mar 8, 2024
1 parent 4b4a723 commit 48afbbe
Showing 1 changed file with 5 additions and 7 deletions.
12 changes: 5 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,18 +32,16 @@ open project in Gitpod
# Running the project on a local environment
Follow these steps to run the project on your local machine:

1. **Fork the Repository:**
Before you clone the repository to your local machine, you need to create a fork of it on GitHub. This allows you to make changes without affecting the original project. To fork the repository, click the "Fork" button at the top right of this page.
1. **DONT Fork the Repository!**
While you can create a fork and submit your pull requests from it, it's really not reccomended. Creating your branch and pull request directly from within the repository will allow our automation pipeline to make a live preview of your contribution and run visual tests against your branch using repository secrets. Just ask, and we will happily grant you write permissions to this repo.

2. **Clone the Repository:**
After forking, you need to clone the repository to your local machine. You can do this by running the following command in your terminal:
Clone the repository to your local machine. You can do this by running the following command in your terminal:

```bash
git clone https://github.com/<Your GitHub Username>/open-bus-map-search.git
git clone https://github.com/hasadna/open-bus-map-search.git
```

Make sure to replace <Your GitHub Username> with your actual GitHub username.

3. **Navigate to the Project Directory:**
Once the repository is cloned, navigate to the project directory by running:

Expand Down Expand Up @@ -71,7 +69,7 @@ Follow these steps to run the project on your local machine:
- Please make sure that the project works on your computer
- do changes and then - do commit (`git commit -m "feat: add some feature"`)
- push the branch to remote repo (`git push`)
- go to the original repo and create a pr (by pressing `create a pr` button)
- go to the repo and create a pr (by pressing `create a pr` button)
- tag one of the maintainers as reviewers
# Commit message convention
Expand Down

0 comments on commit 48afbbe

Please sign in to comment.