Skip to content
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

improving contrib guide and readme #434

Merged
merged 3 commits into from
Oct 10, 2023
Merged

improving contrib guide and readme #434

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5a18f16
improving contrib guide and readme
iagocarmona Oct 10, 2023
dbba8c0
fixing text
iagocarmona Oct 10, 2023
20b57c9
adding remote list after upstream
iagocarmona Oct 10, 2023
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
11 changes: 8 additions & 3 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,13 +203,18 @@ When making a contribution, adhering to the [GitHub flow](https://guides.github.

```bash
# Clone your fork of the repo into the current directory
git clone https://github.com/<your-username>/<repo-name>
git clone https://github.com/<your-username>/activist.git
# Navigate to the newly cloned directory
cd <repo-name>
cd activist
# Assign the original repo to a remote called "upstream"
git remote add upstream https://github.com/<upstream-owner>/<repo-name>
git remote add upstream https://github.com/activist-org/activist.git
```
iagocarmona marked this conversation as resolved.
Show resolved Hide resolved

Now, if you run `git remote -v` you should see two remote repositories named:

- `origin` (forked repository)
- `upstream` (activist repository)

2. If you cloned a while ago, get the latest changes from upstream:

```bash
Expand Down
17 changes: 13 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,16 +125,25 @@ Note that the Figma file above is the [public facing designs](https://www.figma.
> [!NOTE]\
> If you are new to Docker, as an alternative activist recommends installing [Docker Desktop](https://docs.docker.com/desktop/). Docker Desktop comes with many Docker tools and a straightforward user interface.

3. Then clone this repository with the below command:
3. [Fork](http://help.github.com/fork-a-repo/) the repo, clone your fork, and configure the remotes:

```bash
git clone https://github.com/activist-org/activist.git
# Clone your fork of the repo into the current directory
git clone https://github.com/<your-username>/activist.git
# Navigate to the newly cloned directory
cd activist
# Assign the original repo to a remote called "upstream"
git remote add upstream https://github.com/activist-org/activist.git
iagocarmona marked this conversation as resolved.
Show resolved Hide resolved
```

4. Enter the created directory, create a `.env` file and start your docker images with the following:
Now, if you run `git remote -v` you should see two remote repositories named:

- `origin` (forked repository)
- `upstream` (activist repository)

4. Create a `.env` file and start your docker images with the following:

```bash
cd activist
cp .env.example .env
docker-compose up
# Or with new dependencies:
Expand Down