docs: update contributing guide

.env.example

@@ -1,12 +1,45 @@
-# Prisma supports the native connection string format for PostgreSQL, MySQL, SQLite, SQL Server, MongoDB (Preview) and CockroachDB (Preview).
-# See the documentation for all the connection string options: https://pris.ly/d/connection-strings
-DATABASE_URL=
+NODE_ENV=development
 
-NEXTAUTH_URL=
-NEXTAUTH_SECRET=
+DATABASE_URL=postgresql://prisma:hilly-sand-pit@localhost:5432/prisma?schema=prisma-pg-test
+
+PUBLIC_URL=http://localhost:3000
+NEXTAUTH_URL=http://localhost:3000
+NEXTAUTH_SECRET=taskany
 GITHUB_CLIENT_ID=
 GITHUB_CLIENT_SECRET=
+KEYCLOAK_ID=
+KEYCLOAK_ISSUER=
+ACCESS_TOKEN_URL=
+
+JWS_ALGORITHM=
+
+GRAVATAR_HOST=www.gravatar.com
+#NEXT_PUBLIC_GRAVATAR_HOST=www.gravatar.com
 
-SENTRY_IGNORE_API_RESOLUTION_ERROR=
 SENTRY_DSN=
-NEXT_PUBLIC_SENTRY_DSN=
+#NEXT_PUBLIC_SENTRY_DSN=
+SENTRY_DISABLED=0
+SENTRY_AUTH_TOKEN=
+SENTRY_RELEASE=
+
+NEXT_TELEMETRY_DISABLED=
+
+ADMIN_EMAIL=[email protected]
+ADMIN_PASSWORD=admin
+
+MAIL_PORT=
+MAIL_HOST=
+MAIL_USER=[email protected]
+MAIL_PASS=
+
+S3_ENDPOINT=
+S3_REGION=
+S3_BUCKET=
+S3_PATH_STYLE=
+S3_TLS=
+
+
+
+
+
+

CONTRIBUTING.md

@@ -6,13 +6,11 @@ We are open to, and grateful for, any contributions made by the community. By co
 
 Before opening an issue, please search the [issue tracker](https://github.com/taskany-inc/issues/issues) to make sure your issue hasn't already been reported.
 
-
 ### Bugs and Improvements
 
 We use the issue tracker to keep track of bugs and improvements to Taskany itself, its examples, and the documentation. We encourage you to open issues to discuss improvements, architecture, theory, internal implementation, etc. If a topic has been discussed before, we will ask you to join the previous discussion.
 
-As Taskany is stable software, changes to its behavior are very carefully considered. 
-
+As Taskany is stable software, changes to its behavior are very carefully considered.
 
 ### Getting Help
 
@@ -22,7 +20,6 @@ Some questions take a long time to get an answer. **If your question gets closed
 
 Please be considerate when doing this as this is not the primary purpose of the issue tracker.
 
-
 ### Help Us Help You
 
 On both websites, it is a good idea to structure your code and question in a way that is easy to read to entice people to answer it. For example, we encourage you to use syntax highlighting, indentation, and split text in paragraphs.
@@ -34,15 +31,14 @@ Please keep in mind that people spend their free time trying to help you. You ca
 Visit the [issue tracker](https://github.com/taskany-inc/issues/issues) to find a list of open issues that need attention.
 
 Requirements:
-- NodeJS. The best usage experience with NVM. You can find recommended NodeJS version in the [.nvmrc](https://github.com/taskany-inc/issues/blob/main/.nvmrc).
-- Docker. Follow official [docs](https://docs.docker.com/get-docker/) to install it.
-- MailDev. The best way to test mailing. Installation and usage [docs here](https://github.com/maildev/maildev).
 
+-   NodeJS. The best usage experience with NVM. You can find recommended NodeJS version in the [.nvmrc](https://github.com/taskany-inc/issues/blob/main/.nvmrc).
+-   Docker and Docker Compose. Follow official [docs](https://docs.docker.com/get-docker/) to install it.
 
 Fork, then clone the repo:
 
 ```sh
-git clone https://github.com/taskany-inc/issues.git
+git clone git@github.com:taskany-inc/issues.git
 ```
 
 Install dependencies and prepare env:
@@ -55,17 +51,13 @@ cp .env.example .env
 Add your settings to `.env` file. Then prepate database:
 
 ```sh
+npm run db:init
 npm run db:run
-npx prisma migrate dev --preview-feature
-npx prisma db seed
-```
-
-Now all set:
-
-```sh
 npm run dev
 ```
 
+Point your browser to http://localhost:3000 :tada:
+
 ### Testing and Linting
 
 To only run linting:
@@ -84,7 +76,6 @@ npm run test
 
 Improvements to the documentation are always welcome. You can find them in the [`docs`](/docs) path.
 
-
 ### Sending a Pull Request
 
 For non-trivial changes, please open an issue with a proposal for a new feature or refactoring before starting on the work. We don't want you to waste your efforts on a pull request that we won't want to accept.
@@ -93,11 +84,11 @@ On the other hand, sometimes the best way to start a conversation _is_ to send a
 
 In general, the contribution workflow looks like this:
 
-- Open a new issue in the [Issue tracker](https://github.com/taskany-inc/issues/issues).
-- Fork the repo.
-- Create a new branch based off the `master` branch. Branch name must follow pattern `issues/{id}`.
-- Make sure all tests pass and there are no linting errors.
-- Submit a pull request, referencing any issues it addresses.
+-   Open a new issue in the [Issue tracker](https://github.com/taskany-inc/issues/issues).
+-   Fork the repo.
+-   Create a new branch based off the `master` branch. Branch name must follow pattern `issues/{id}`.
+-   Make sure all tests pass and there are no linting errors.
+-   Submit a pull request, referencing any issues it addresses.
 
 Please try to keep your pull request focused in scope and avoid including unrelated commits.
 

package.json

@@ -12,6 +12,7 @@
     "generate:types": "node ./scripts/types.js",
     "watch:types": "nodemon --exec \"npm run generate:types\" --watch \"src/pages/help/**/*.md\"",
     "generate": "concurrently \"npm run generate:types\"",
+    "db:init": "npx prisma migrate dev --preview-feature && npx prisma db seed",
     "db:run": "docker-compose -f docker-compose.dev.yml up -d",
     "db:down": "docker-compose down",
     "test": "jest",