.dir-locals.el

@@ -1,2 +1,11 @@
 ((emacs-lisp-mode
-  (indent-tabs-mode nil)))
+  (bug-reference-url-format . "https://github.com/trevorpogue/topspace/issues/%s")
+  (bug-reference-bug-regexp . "#\\(?2:[[:digit:]]+\\)")
+  (indent-tabs-mode . nil)
+  (fill-column . 80)
+  (sentence-end-double-space . t)
+  (emacs-lisp-docstring-fill-column . 75)
+  (checkdoc-symbol-words . ("top-level" "major-mode" "macroexpand-all" "print-level" "print-length"))
+  (checkdoc-package-keywords-flag)
+  (checkdoc-arguments-in-order-flag)
+  (checkdoc-verb-check-experimental-flag)))

.github/FUNDING.yml

@@ -0,0 +1,13 @@
+# These are supported funding model platforms
+
+github: trevorpogue # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,45 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+
+*Example:*
+1. Open Emacs
+2. Run this exact combination of commands '....'
+3. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+### topspace version information
+
+### Emacs version
+
+*Example: 24.5* (use <kbd>C-h C-a</kbd> to see it)
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/custom.md

@@ -0,0 +1,10 @@
+---
+name: Custom issue template
+about: Describe this issue template's purpose here.
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,18 @@
+**Replace this placeholder text with a summary of the changes in your PR.
+The more detailed you are, the better.**
+
+-----------------
+
+### Checklist
+
+<!-- Please confirm with `x`: -->
+
+- [ ] I have read the topspace [contributing guidelines](https://github.com/trevorpogue/topspace/blob/main/CONTRIBUTING.md)
+- [ ] My changes follow the [Emacs Lisp](https://www.gnu.org/software/emacs/manual/html_node/elisp/Tips.html) conventions and the [Emacs Lisp Style Guide](https://github.com/bbatsov/emacs-lisp-style-guide)
+- [ ] I've used the latest version of [package-lint](https://github.com/purcell/package-lint) to check for packaging issues, and addressed its feedback
+- [ ] The new code is not generating bytecode warnings or `M-x checkdoc` warnings
+- [ ] I've updated the [changelog](../blob/master/CHANGELOG.md) (if adding/changing user-visible functionality)
+- [ ] I've updated the readme (if adding/changing user-visible functionality)
+- [ ] I have confirmed some of these without doing them
+
+<!-- Thank you! -->

CHANGELOG.md

@@ -0,0 +1,41 @@
+# Changelog
+
+## main (unreleased)
+
+### New features
+
+### Bugs fixed
+
+### Changes
+
+## 0.1.2 (2022-03-01)
+
+### New features
+
+### Bugs fixed
+* [#2](https://github.com/trevorpogue/topspace/pull/2): Make `recenter-top-bottom` act correctly when it moves point to bottom and top space is added to get there
+
+### Changes
+
+* [2584138](https://github.com/trevorpogue/topspace/commit/25841387a5d0300ea49356b9781c357b84df20bd): Raise topspace-center-position default to a subjectively better position
+
+## 0.1.1 (2022-02-22)
+
+### New features
+
+### Bugs fixed
+* [4a69b2e](https://github.com/trevorpogue/topspace/commit/4a69b2eb741f8db9d69169a03a6724af0f2ec7ac): Allow recenter and recenter-top-bottom to be called interactively without an error
+* [4eb27ab](https://github.com/trevorpogue/topspace/commit/4eb27abaa182e856ba3f3c8e1e84fdd2e1f009af): Prevent top space from all suddenly disappearing when visual-line-mode is enabled and cursor scrolls bellow window-end when top space is present
+
+### Changes
+
+## 0.1.0 (2022-02-19)
+
+### New features
+* [#1](https://github.com/trevorpogue/topspace/pull/1): Make mode work for any scrolling command by using add-advice with scroll-up, scroll-down, and recenter
+
+### Bugs fixed
+* [#1](https://github.com/trevorpogue/topspace/pull/1): Stabilize, clean up, and add performance optimizations to code to make it ready for submission to MELPA
+
+### Changes
+* [e5b65ec](https://github.com/trevorpogue/topspace/commit/e5b65eccf92571163aa1b6bd738be22d8e0ad1a5): Change project name from vertical-center-mode to topspace

CONTRIBUTING.md

@@ -0,0 +1,35 @@
+# Contributing
+
+Feel free to work on reported and unresolved issues. 
+If you discover issues, have ideas for improvements or new features, please
+report them to the [issue tracker][1] of the repository or submit a pull
+request. Please, try to follow these guidelines when you do so.
+
+## Issue reporting
+
+* Check that the issue has not already been reported.
+* Check that the issue has not already been fixed in the latest code
+  (a.k.a. `master`).
+* Be clear, concise and precise in your description of the problem.
+* Open an issue with a descriptive title and a summary in grammatically correct,
+  complete sentences.
+* Include any relevant code to the issue summary.
+* If you're reporting performance issues it'd be nice if you added some profiling data (Emacs has a built-in profiler).
+
+## Pull requests
+
+* Read [how to properly contribute to open source projects on Github][2].
+* Use a topic branch to easily amend a pull request later, if necessary.
+* Write [good commit messages][3].
+* Mention related tickets in the commit messages (e.g. `[Fix #N] Add missing autoload cookies`)
+* Update the [changelog][5].
+* Use the same coding conventions as the rest of the project.
+* Verify your Emacs Lisp code with `checkdoc` (<kbd>C-c ? d</kbd>).
+* Open a [pull request][4] that relates to *only* one subject with a clear title
+  and description in grammatically correct, complete sentences.
+
+[1]: https://github.com/trevorpogue/topspace/issues
+[2]: http://gun.io/blog/how-to-github-fork-branch-and-pull-request
+[3]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
+[4]: https://help.github.com/articles/using-pull-requests
+[5]: https://github.com/trevorpogue/topspace/blob/main/CHANGELOG.md

README.md

@@ -1,80 +1,95 @@
-# TopSpace
+<h1 align="center"> TopSpace </h1>
+<p align="center">Scroll down & recenter top lines in Emacs / get upper margins/padding.</p>
 
-[![MELPA](http://melpa.org/packages/topspace-badge.svg)](http://melpa.org/#/topspace)
-[![MELPA Stable](http://stable.melpa.org/packages/topspace-badge.svg)](http://stable.melpa.org/#/topspace)
-[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
+<!-- padding cursor -->
 
-**Scroll above the top line**
+<p align="center">
+  <a href="http://melpa.org/#/topspace"><img src="http://melpa.org/packages/topspace-badge.svg" height="20"/></a>
+  <a href="http://stable.melpa.org/#/topspace"><img src="http://stable.melpa.org/packages/topspace-badge.svg" height="20"/></a>
+  <a href="https://www.gnu.org/licenses/gpl-3.0"><img src="https://img.shields.io/badge/License-GPLv3-blue.svg" height="20"/></a>
+</p>
 
-![topspace](https://user-images.githubusercontent.com/12535207/155176914-87390537-10f0-4ee5-9b37-cd798f07df27.gif)
+<p align="center"><img src="https://user-images.githubusercontent.com/12535207/155176914-87390537-10f0-4ee5-9b37-cd798f07df27.gif" /></a></p>
 
-TopSpace is an Emacs minor mode that lets you scroll above the top line to vertically center top text or cursor with a scrollable top margin/padding. In particular, it is useful when using Emacs in full-screen/on large monitors.
+TopSpace is an Emacs minor mode that allows you to scroll down and recenter top lines
+by automatically drawing an upper margin/padding above the top line
+as you scroll down or recenter top text.
 
-### Just install and go:
+TopSpace is:
 
-No new keybindings are required as `topspace` automatically works for any
-commands or subsequent function calls which use `scroll-up`, `scroll-down`,
-or `recenter` as the underlying primitives for scrolling. This includes all
-scrolling commands/functions available in Emacs as far as the author is aware.
 
-### How it works:
-
-The top "margin" is created by drawing an [overlay](https://www.gnu.org/software/emacs/manual/html_node/elisp/Overlays.html) before window-start which contains nothing but newline characters. As you scroll, more newline characters are added or removed accordingly.
-
-Bonus: If you use [`centered-cursor-mode`][1], this means that `topspace` will automatically let you center the cursor all the way to the top line!
+* **Easier on the eyes**: Recenter or scroll down top text to a more comfortable eye level for reading, especially when in full-screen or on a large monitor.
+* **Easy to use**: No new keybindings are required, keep using all your previous scrolling & recentering commands, except now you can also scroll above the top lines. It also integrates seamlessly with  [centered-cursor-mode][1] to keep the cursor centered all the way to the top line.
 
 # Installation
 
 TopSpace is available on [MELPA](http://melpa.org).
 After [installing MELPA](https://melpa.org/#/getting-started) you can install TopSpace with the following command:
 
-<kbd>M-x</kbd> `package-install` <kbd>[RET]</kbd> `topspace` <kbd>[RET]</kbd>
+&nbsp;&nbsp;&nbsp;&nbsp; <kbd>M-x</kbd> `package-install` <kbd>[RET]</kbd> `topspace` <kbd>[RET]</kbd>
 
-If `topspace` did not appear here in `package-install` try running <kbd>M-x</kbd> `package-refresh-contents` and repeating the above step. Then enable TopSpace locally with <kbd>M-x</kbd> `topspace-mode`, or globally with <kbd>M-x</kbd> `global-topspace-mode`.
-Alternatively, add `(global-topspace-mode 1)` to your Emacs config to enable `topspace-mode` globally on startup.
+If `topspace` did not appear here in `package-install` try running <kbd>M-x</kbd> `package-refresh-contents` and repeating the above step.
 
-# Customization
-By default, small buffers will be vertically centered with top space when first opened. To disable this feature, simply add the following to your Emacs config:
-```
-(custom-set-variables '(topspace-autocenter-buffers nil))
+Then enable TopSpace locally with
+
+&nbsp;&nbsp;&nbsp;&nbsp; <kbd>M-x</kbd> `topspace-mode`,
+
+or globally with
+
+&nbsp;&nbsp;&nbsp;&nbsp; <kbd>M-x</kbd> `global-topspace-mode`.
+
+To enable `topspace-mode` globally on startup, add the following to your Emacs config:
 ```
-More options/detail:
+(global-topspace-mode 1)
 ```
-(defcustom topspace-autocenter-buffers
-  t
-  "Vertically center small buffers when first opened or window sizes change.
 
-This is done by automatically calling `topspace-recenter-buffer',
-which adds enough top space to center small buffers.
+# Customization
+### `topspace-autocenter-buffer`
+* Description: By default, small buffers will be vertically centered with top space when first opened by calling `topspace-recenter-buffer` (described below).
 Top space will not be added if the number of text lines in the buffer is larger
 than or close to the selected window's height.
-Customize `topspace-center-position' to adjust the centering position."
-  :group 'topspace
-  :type 'boolean)
-
-(defcustom topspace-center-position
-  0.5
-  "Target position when centering buffers as a ratio of frame height.
-A value from 0 to 1 where lower values center buffers higher up in the screen.
-
-Used in `topspace-recenter-buffer' when called or when opening/resizing buffers
-if `topspace-autocenter-buffers' is non-nil."
-  :group 'topspace
-  :type 'float)
+Customize `topspace-center-position` (described below) to adjust the centering position.
+* Default value: t
+* Type: boolean
+* How to modify: Disable this feature by adding the following to your Emacs config:
+```
+(custom-set-variables '(topspace-autocenter-buffers nil))
 ```
 
-# Extra commands
-
-### `topspace-recenter-buffer`:
+### `topspace-center-position`
+* Description: Target position when centering buffers as a ratio of frame height. It must be a value from 0 to 1 where lower values center buffers higher up in the screen. Used in `topspace-recenter-buffer` (described below) when called or when opening/resizing buffers if `topspace-autocenter-buffers` is non-nil.
+* Default value: 0.4
+* Type: float
+* How to modify: Add the following to your Emacs config:
+```
+(custom-set-variables '(topspace-center-position <custom value>))
+```
 
-Add enough top space in the selected window to center small buffers.
+# Extra commands
 
+### `topspace-recenter-buffer`
+* Add enough top space in the selected window to center small buffers.
 Top space will not be added if the number of text lines in the buffer is larger
 than or close to the selected window's height.
-
 Customize `topspace-center-position` to adjust the centering position.
 Customize `topspace-autocenter-buffers` to run this command automatically
 after first opening buffers and after window sizes change.
 
+# How it works under the hood
+
+The "upper margin" is created by drawing an overlay before
+window-start containing newline characters.  As you scroll above the
+top line, more newline characters are added or removed accordingly.
+
+No new keybindings are required as topspace automatically works for
+any commands or subsequent function calls which use `scroll-up`,
+`scroll-down`, or `recenter` as the underlying primitives for
+scrolling.  This includes all scrolling commands/functions available
+in Emacs as far as the author is aware. This is achieved by using
+`advice-add` with the `scroll-up`, `scroll-down`, and `recenter`
+commands so that custom topspace functions are called before or after
+each time any of these other commands are called (interactively or
+otherwise).
+
 
-  [1]: https://github.com/andre-r/centered-cursor-mode.el
+[1]: https://github.com/andre-r/centered-cursor-mode.el