Unverified Commit 5f9bb675 authored by Mark Vander Stel's avatar Mark Vander Stel
Browse files

Update CONTRIBUTING and issue templates

The one issue template needed some help. And now that I'm working to
improve speed of the prompt, we can accept feature requests again.
parent 109f01f5
Shell: bash/zsh
Operating system:
Liquid Prompt version (tag, commit):
---
name: Bug report
about: Create a report to help us improve Liquidprompt
title: ''
labels: 'bug'
assignees: ''
---
<!--- Provide a general summary of the issue in the title above -->
<!---
Shell name and version.
Find with
`echo $BASH_VERSION`
or
`echo $ZSH_VERSION`
Example: "bash 4.4.19(1)-release"
-->
Shell:
<!---
Operating system name and version.
Find with
`uname -a`
and either
`lsb_release -a` or `cat /etc/*release` or `cat /etc/issue*` or `cat /proc/version`
Example: "Linux 4.18.0-147.8.1.el8_1.x86_64, CentOS release 8.1.1911 (Core)"
-->
Operating system:
<!---
Liquidprompt version, tag and/or commit.
Find with
`git rev-parse HEAD` in the liquidprompt repo.
Please only report bugs that you have tested against the master branch
Example: "aece92c2bffdb90e28cd0aa552ea4dfad5d96643"
-->
Liquid Prompt version:
### Expected Behavior
<!--- Tell us what should happen -->
### Current Behavior
<!--- Tell us what happens instead of the expected behavior -->
### Possible Solution
<!--- Optional, suggest a fix for the bug, -->
### Steps to Reproduce
<!--- Provide an unambiguous set of steps to reproduce this bug.
Include code to reproduce, if relevant -->
1.
2.
3.
### Possible Implementation
<!--- Optional, suggest an idea for fixing the bug -->
blank_issues_enabled: false
---
name: Feature request
about: Suggest an idea for Liquidprompt
title: ''
labels: 'enhancement'
assignees: ''
---
<!--- Provide a general summary of the issue in the title above -->
<!--- This is only a template, feel free to expand -->
### Description
<!--- Tell us what should happen -->
### How will this be useful?
<!--- Tell/show us how this feature will be used -->
### Example prompt
<!--- Show us what a prompt with this feature enabled would look like -->
Contributing to Liquid Prompt
=============================
# Contributing to Liquid Prompt
Contributing a patch
--------------------
### I don't want to read this whole thing, I just have a question!!!
The public stable branch for end users is `master`.
Please don't file an issue to ask a question. You'll get faster results by
using the resources below.
## Did you find a bug?
How to do the right thing?
--------------------------
* **Check the [FAQs](https://github.com/nojhan/liquidprompt/wiki/FAQ)**. We
try to keep it updated with the latest hot questions.
* **Ensure the bug was not already reported** by searching on GitHub under
[Issues](https://github.com/nojhan/liquidprompt/issues). If there is an open
issue that matches your problem, you can add a comment to the issue if you
have something new or helpful to add. If your comment would be ":+1:",
please add that as a reaction on the issue instead.
* **Ensure you can reproduce the issue on the latest version**. Not only the
latest released version, but the latest commit on the `master` branch. While
it might not be the version you are using right now, if the bug doesn't exist
on the `master` branch, we have already fixed it.
* If you're unable to find an open issue addressing the problem, [open a new
one](https://github.com/nojhan/liquidprompt/issues/new/choose). Be sure to
include a **title and clear description**, as much relevant information as
possible, such as shell version, and a **code sample** or a **test case**
demonstrating the expected behavior that is not occurring. If we can't
reproduce the bug, we can't fix it, so make sure to include as much
information as possible.
## Enhancement / Feature request
Same as with bugs, **check the [FAQs](https://github.com/nojhan/liquidprompt/wiki/FAQ)
and open [Issues](https://github.com/nojhan/liquidprompt/issues)** so you don't
duplicate a feature request.
[Open a new Issue](https://github.com/nojhan/liquidprompt/issues/new/choose),
and add as much detail as you can. Make sure to at least explain:
1. **Why** you want this feature. How will it be useful to users?
2. **What** tools it will interact with (ex: `git`). Provide links.
3. **An example** of what it would look like in the prompt.
The more details you can give, the more likely someone will be inspired to work
on it.
## Contributing a patch
### Your first contribution / what can I help with?
If you just want to help, but don't have a specific issue in mind, you can
look at the [help wanted](https://github.com/nojhan/liquidprompt/labels/help%20wanted)
tagged issues.
### Code style and standards
[Google's shell style guide](https://google.github.io/styleguide/shellguide.html)
is our style guide, with the following modifications:
* 4 spaces indentation
* Don't always prefer `${var}` over `$var` (see standards)
* Use `typeset`, not `local` or `declare` (see standards)
See our [shell standards wiki page](https://github.com/nojhan/liquidprompt/wiki/Shell-standards)
for our standards on shell language.
### How do I make a pull request??
$ git clone -o upstream git://github.com/nojhan/liquidprompt.git
$ cd liquidprompt
......@@ -18,11 +73,11 @@ How to do the right thing?
# Prepare a fix (include the issue number in the branch name if an issue
# already exists)
$ git checkout -b fix/my-fix
$ git checkout -b bugfix/my-fix
# Prepare a new feature
$ git checkout -b feature/my-feature
# Hack, commit, hack, commit...
# Hack, commit, hack, amend commit...
# Fork the project on GitHub (if you haven't yet)
......@@ -30,7 +85,7 @@ How to do the right thing?
$ git remote add github git@github.com:$GITHUB_USER/liquidprompt.git
# Check that your local repo is up to date
$ git fetch
$ git fetch upstream
# Rebase your work on the latest state of `master`
$ git rebase upstream/master
......@@ -41,9 +96,7 @@ How to do the right thing?
# Create the pull request on GitHub. Check that Github chose the `master`
# branch as the starting point for your branch.
How to make a good pull request?
--------------------------------
### How do I make a good pull request?
1. Check that your Git authorship settings are correct:
......@@ -52,27 +105,46 @@ How to make a good pull request?
2. All the commits in the pull request must be on the same topic. If instead
you propose fixes on different topics, use separate branches in your repo
and make a pull request for each.
3. Good commit messages:
- first line must be 72 chars max and is a summary of the commit
3. Good commit message:
- first line must be 50 chars max and is a summary of the commit. The
first charcter should be capitalized, no ending period. Use the
imperative mood ("fix thing", not "fixes thing" or "fixing thing" or
"fixed thing")
- second line must be empty
- following lines (72 chars max) are optional and take this space freely
to express what that changes does.
- following lines (72 chars max) should describe the what, why, and how
of your change. If your change is anything more than one line, this is
probably not optional. Think about coming back to this patch in 6
months: if you won't remember why you made this change, you need to
write it down.
Use references to GitHub issues number (ex: `#432`) if applicable
4. Use a good title for your pull request.
5. Put details, web links, in the pull request body. Use Markdown fully to
format the content (see
[Markdown syntax](http://daringfireball.net/projects/markdown/syntax)).
For example use triple backquotes for code blocks.
A good commit message isn't optional. If your commit message is bad (ex:
"fix temp for thing"), your PR will be rejected.
[See this post](https://chris.beams.io/posts/git-commit/) for even more
details on the topic.
4. Use a good title for your pull request.
Never, ever, merge the branches `master` of the main repo into one
of your own branches. Instead, always rebase your own work on top the `master`
branch.
How my patch will be applied?
-----------------------------
Before being applied, your pull request will be reviewed, by the maintainer
5. Put details, web links, Github issue numbers, in the pull request body. Use
Markdown fully to format the content (see
[Markdown syntax](https://guides.github.com/features/mastering-markdown/)).
For example use triple backquotes for code blocks.
Note that if information is important enough to put in the PR description,
it is also important enough to put in the commit message.
If your branch ever ends up "out of sync" or "conflicts" with the `master`
branch of the main repo, never, ever, merge the `master` branch into your own
branch. Instead, always rebase your own work on top of the `master` branch.
### Can I make a pull request without a separate issue for a bug/enhancement?
Yes, **but**, in that case, the pull request **must have a full description of
the bug or feature**. Just because you have fixed/implemented it already
doesn't mean you can skip the details. The reviewers of the pull request still
need to know all of the information you would normally put in the bug report or
feature request.
### How my patch will be applied?
Before being applied, your pull request will be reviewed by the maintainer
and also by other users. You can also help the project by reviewing others
pull requests.
......@@ -83,11 +155,10 @@ If your patch is accepted it will be applied either:
In any case, your authorship will be preserved in the commit.
What if my patch is not applied?
--------------------------------
### What if my patch is not applied?
If you don't even get a review, add a "ping" comment with increasing delay
between pings: 1 week, 2 weeks, then every month.
between pings: 1 week, 2 weeks, then every month. But I'm trying to do better
on this than what was happening before.
If a stable version is released while your pull request has still not been
merged on any working branch of the main repo, it would be helpful to ease
......@@ -96,6 +167,4 @@ and push it again to your GitHub repo. Be careful (for example create a
branch or a tag before your rebase) because your may lose all your work in
that process.
Olivier Mengué, maintainer.
http://github.com/dolmen
[@Rycieos](https://github.com/Rycieos), maintainer.
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment