Skip to content

Commit 5bd7c7f

Browse files
committed
📚 DOCS: Remove Issue Templates
These are now handled centrally in executablebooks/.github
1 parent df2c110 commit 5bd7c7f

4 files changed

Lines changed: 2 additions & 80 deletions

File tree

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 0 additions & 31 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/documentation-improvements.md

Lines changed: 0 additions & 14 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 0 additions & 20 deletions
This file was deleted.

README.md

Lines changed: 2 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -420,6 +420,8 @@ Assets:
420420

421421
## Contributing
422422

423+
jupyter-cache follows the [Executable Book Contribution Guide](https://executablebooks.org/en/latest/contributing.html). We'd love your help!
424+
423425
### Code Style
424426

425427
Code style is tested using [flake8](http://flake8.pycqa.org),
@@ -444,18 +446,3 @@ Optionally you can run `black` and `flake8` separately:
444446
```
445447

446448
Editors like VS Code also have automatic code reformat utilities, which can adhere to this standard.
447-
448-
### Pull Requests
449-
450-
To contribute, make Pull Requests to the `develop` branch (this is the default branch). A PR can consist of one or multiple commits. Before you open a PR, make sure to clean up your commit history and create the commits that you think best divide up the total work as outlined above (use `git rebase` and `git commit --amend`). Ensure all commit messages clearly summarise the changes in the header and the problem that this commit is solving in the body.
451-
452-
Merging pull requests: There are three ways of 'merging' pull requests on GitHub:
453-
454-
- Squash and merge: take all commits, squash them into a single one and put it on top of the base branch.
455-
Choose this for pull requests that address a single issue and are well represented by a single commit.
456-
Make sure to clean the commit message (title & body)
457-
- Rebase and merge: take all commits and 'recreate' them on top of the base branch. All commits will be recreated with new hashes.
458-
Choose this for pull requests that require more than a single commit.
459-
Examples: PRs that contain multiple commits with individually significant changes; PRs that have commits from different authors (squashing commits would remove attribution)
460-
- Merge with merge commit: put all commits as they are on the base branch, with a merge commit on top
461-
Choose for collaborative PRs with many commits. Here, the merge commit provides actual benefits.

0 commit comments

Comments
 (0)