Skip to content

Commit

Permalink
add contribution guide to README
Browse files Browse the repository at this point in the history
  • Loading branch information
mazma1 committed Jul 6, 2020
1 parent 853291b commit 0807fa9
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 2 deletions.
30 changes: 30 additions & 0 deletions CONTRIBUTION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
## Contributions

This project is open for contributions. All contributions must adhere to the [Airbnb Javascript](http://airbnb.io/javascript/) style guide.

#### To get started:
1. Create a feature branch for any issue you want to resolve

2. Implement the said feature

4. Commit your changes
> Your commit message(s) should follow the format below. It should comprise of:
> * A header: summarizes what feature was implemented
>* A body: gives a concise description of said feature
> ```
> feat(kafka): implement exactly one time delivery
> - ensure every event published to kafka is delivered exactly once
> - implement error handling for failed delivery
4. Raise a pull request to the `develop` branch
> Pull requests should also follow the format below:
> ```
> - What does this PR do?
> - Description of Task to be completed?
> - How should this be manually tested?
> - Any background context you want to provide?
> - Screenshots (if appropriate)
> - Questions
5. Once your pull request has been reviewed and any possible feedback addressed, your work will be merged.

7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# book-gallery-api
A simple authentication API for the books gallery app
A simple authentication API for the [books gallery app](https://github.com/she-code-africa/WOSCA-book-gallery)

## Core Technologies
1. NodeJS/Express
Expand Down Expand Up @@ -42,4 +42,7 @@ A simple authentication API for the books gallery app
2. Install all dependencies:
```
npm run start:dev
```
```

### Contributing
Refer to the contribution guidelines for this project [here](CONTRIBUTION.md)

3 comments on commit 0807fa9

@jenniekibiri
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the db migration please add the --url " " to the command

sequelize db:migrate --url 'postgres://user:password@localhost:5432/bookgalle
ry'

@mazma1
Copy link
Collaborator Author

@mazma1 mazma1 commented on 0807fa9 Jul 16, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @jenniekibiri, adding the DB URL to the sequelize command is not necessary.
If you add the URL to your local .env file as specified in the README file, sequelize will pick the URL up. A sample .env.sample was provided as a guide of what your .env should look like

@jenniekibiri
Copy link
Contributor

@jenniekibiri jenniekibiri commented on 0807fa9 Jul 16, 2020 via email

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.