Skip to content

Commit

Permalink
Adds Contributing section in Readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
rodgracas committed Jun 6, 2021
1 parent a85a423 commit 57bc7fb
Showing 1 changed file with 16 additions and 4 deletions.
20 changes: 16 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ cd cliptale
### Instagram credentials

```bash
# Create a `.env` file in project root.
# Create a .env file in project root.
cp .env.sample .env
```

Expand All @@ -41,17 +41,29 @@ npm install
## Run

```bash
# Run cliptale
npm start
```

> **Note**: By default `cliptale` runs in headless mode. To run in headfull mode, set `DEBUG` variable to `true` on `clipping.js` file.

## Next steps

- [x] Run in headless mode
- [ ] Add prettier/eslint
- [ ] Write tests
- [ ] Typescript support
- [ ] Create web application
- [ ] Create web application

## Contributing

Contributions are welcome 😀 This is my first open-source project on Github, so I would be very grateful to share your thoughts on this project, solve any issues and receive your feedback for improvements or enhancements.

When contributing to this repository, please first discuss the change you wish to make by opening an issue.

### Pull Request Process

1. Fork the repo on GitHub
2. Clone the forked repo to your machine
3. Commit changes to your own branch
4. Push your work onto your forked repository
5. Submit a Pull request so that I can review your changes

0 comments on commit 57bc7fb

Please sign in to comment.