Skip to content

Commit

Permalink
updating docs
Browse files Browse the repository at this point in the history
  • Loading branch information
codeperfectplus committed Oct 23, 2020
1 parent 6b9a2e1 commit 2f76fd0
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 51 deletions.
33 changes: 0 additions & 33 deletions .github/ISSUE_TEMPLATE/create-a-new-script.md

This file was deleted.

46 changes: 28 additions & 18 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,43 +10,53 @@ We love your input! We want to make contributing to this project as easy and tra

## Steps to contribute

* Comment on the issue you want to work on. Make sure it's not assigned to someone else.
- Comment on the issue you want to work on. Make sure it's not assigned to someone else.

### Making a PR

> - Make sure you have been assigned the issue to which you are making a PR.
> - If you make PR before being assigned, It will be labeled `invalid` and closed without merging.
* Fork the repo and clone it on your machine.
* Add a upstream link to main branch in your cloned repo
```
- Fork the repo and clone it on your machine.
- Add a upstream link to main branch in your cloned repo

```sh
git remote add upstream https://github.com/codeperfectplus/audiobook.git
```
* Keep your cloned repo upto date by pulling from upstream (this will also avoid any merge conflicts while committing new changes)
```

- Keep your cloned repo upto date by pulling from upstream (this will also avoid any merge conflicts while committing new changes)

```sh
git pull upstream master
```
* Create your feature branch
```

- Create your feature branch

```sh
git checkout -b <feature-name>
```
* Commit all the changes
```

- Commit all the changes

```sh
git commit -am "Meaningful commit message"
```
* Push the changes for review
```

- Push the changes for review

```sh
git push origin <branch-name>
```
* Create a PR from our repo on Github.

- Create a PR from our repo on Github.

### Additional Notes

* Code should be properly commented to ensure it's readability.
* If you've added code that should be tested, add tests as comments.
* Make sure your code properly formatted.
* Issue that pull request!
* use Flake8 for python code
- Code should be properly commented to ensure it's readability.
- If you've added code that should be tested, add tests as comments.
- Make sure your code properly formatted.
- Issue that pull request!
- use Flake8 for python code

## Issue suggestions/Bug reporting

Expand Down

0 comments on commit 2f76fd0

Please sign in to comment.