Skip to content

Commit a6c178c

Browse files
committed
docs: update some important info about contributing
1 parent bccbb56 commit a6c178c

File tree

3 files changed

+13
-12
lines changed

3 files changed

+13
-12
lines changed

.env.example

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@ DATABASE_URL="mysql://root:password@localhost:3306/trello_clone?schema=public"
22

33
NEXTAUTH_SECRET=SECRET
44
NEXTAUTH_URL=http://localhost:3000
5+
APP_URL=http://localhost:3000
56

7+
# OPTIONAL
68
GITHUB_SECRET=
79
GITHUB_ID=
810

911
DISCORD_ID=
1012
DISCORD_SECRET=
11-
12-
APP_URL=http://localhost:3000

CONTRIBUTING.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -41,11 +41,12 @@ If you want to work on your suggestion as well, please open an issue before you
4141

4242
If there's an issue you want to fix or develop, or if you've submitted an issue as a feature request and want to work on the solution:
4343

44-
1. Fork this repository
45-
2. Clone your fork
46-
3. Start working on your changes
47-
4. Commit and push your changes
48-
5. Open a Pull Request with your changes
44+
1. Write a comment under the issue that you would like to work on it, so I can assign you the issue
45+
2. Fork this repository
46+
3. Clone your fork
47+
4. Start working on your changes
48+
5. Commit and push your changes
49+
6. Open a Pull Request with your changes
4950

5051
### Other ways
5152

@@ -59,5 +60,5 @@ If you don't have any ideas yet, but want to support the project:
5960

6061
## General information
6162

62-
- You can open the pull request directly against the main branch.
63-
- If possible, please use a [pull request template](./.github/PULL_REQUEST_TEMPLATE.md) when you open a PR.
63+
- Please use a [pull request template](./.github/PULL_REQUEST_TEMPLATE.md) when you open a PR.
64+
- Please, when writing your commit messages, use [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/).

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -70,14 +70,14 @@ docker compose up -d
7070
npm i
7171
npm run prepare
7272

73-
# Migrate the DB (and optionally seed it)
73+
# Reset the DB
7474
npx prisma migrate reset
7575

76-
# Run the application:
76+
# Run the application
7777
npm run dev
7878
```
7979

80-
After the successful installation, you can log in with the following credentials: username: **test**, password: **test**
80+
After the successful installation, the app should start [here](http://localhost:3000). You can log in with the following credentials: username: **test**, password: **test**
8181

8282
## License
8383

0 commit comments

Comments
 (0)