-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(readme): use common CONTRIBUTING.md
- Loading branch information
1 parent
ae8a0d9
commit 05104e8
Showing
2 changed files
with
13 additions
and
37 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,35 +1,3 @@ | ||
## Contributing | ||
|
||
Here are listed all the ways you can contribute to the project. | ||
|
||
### Issues | ||
|
||
If you encounter an issue, you can create a | ||
[Github issue](https://github.com/ManoManoTech/homer/issues/new). | ||
|
||
### Develop | ||
|
||
#### Necessary environment variables | ||
|
||
- **GITLAB_SECRET_TOKEN**: from Gitlab project webhooks, to validate incoming | ||
Gitlab requests. | ||
- **GITLAB_TOKEN**: to interact with the Gitlab API. | ||
- **POSTGRES_HOST**: host of the PostgreSQL database. | ||
- **POSTGRES_PASSWORD**: password used when connecting to the PostgreSQL | ||
database. | ||
- **POSTGRES_PORT**: port where the PostgreSQL database listens. | ||
- **POSTGRES_USER**: username used when connecting to the PostgreSQL database. | ||
- **SLACK_BOT_USER_O_AUTH_ACCESS_TOKEN**: to publish Slack messages. | ||
- **SLACK_SIGNING_SECRET**: to validate incoming Slack requests. | ||
|
||
#### Use Ngrok | ||
|
||
```bash | ||
ngrok http localhost:3000 | ||
``` | ||
|
||
#### Start the database locally | ||
|
||
```bash | ||
docker compose up -d | ||
``` | ||
See [Contributing to this repository](https://github.com/ManoManoTech/ALaMano/blob/master/CONTRIBUTING.md). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters