mirrors/prezto
1
0
Fork 1
mirror of https://github.com/sorin-ionescu/prezto.git synced 2024-04-29 08:23:46 +02:00
Code Issues Packages Projects Releases Wiki Activity
prezto/CONTRIBUTING.md

75 lines
2.5 KiB
Markdown
Raw Permalink Normal View History

general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 03:59:31 +02:00
# Contributing
[Fix #293] Add CONTRIBUTING.md
2012-09-25 19:12:35 +02:00
This project would not exist without all of its users and [contributors][1].
If you have ideas on how to make the configuration easier to maintain or
improve its performance, do not hesitate to fork and send pull requests.
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 03:59:31 +02:00
## Issue Reporting
[Fix #293] Add CONTRIBUTING.md
2012-09-25 19:12:35 +02:00
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 03:59:31 +02:00
- Check that the issue has not already been reported.
- Check that the issue has not already been fixed in the latest code.
- Open an issue with a clear title and description in grammatically correct,
complete sentences.
[Fix #293] Add CONTRIBUTING.md
2012-09-25 19:12:35 +02:00
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 03:59:31 +02:00
## Pull Request
[Fix #293] Add CONTRIBUTING.md
2012-09-25 19:12:35 +02:00
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 03:59:31 +02:00
- 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].
- Squash commits on the topic branch before opening a pull request.
- Use the same coding style and spacing.
- Open a [pull request][4] that relates to but one subject with a clear title
and description in grammatically correct, complete sentences.
[Fix #293] Add CONTRIBUTING.md
2012-09-25 19:12:35 +02:00
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 03:59:31 +02:00
### Code Style
Add code style to CONTRIBUTING.md Closes #1296
2017-04-15 10:14:09 +02:00
Remove redundant style rules from CONTRIBUTING.md
2017-06-26 23:40:31 +02:00
This project follows the [Google Shell Style Guide][5] when possible. However,
there are a number of additional things to keep in mind.
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 03:59:31 +02:00
- Local variables should be used whenever possible.
- Prefer `zstyle` over environment variables for configuration.
- Prefer (( ... )) over [[ ... ]] for arithmetic expression.
- Use the function keyword to define functions.
- The 80 character hard limit can be waived for readability.
Add code style to CONTRIBUTING.md Closes #1296
2017-04-15 10:14:09 +02:00
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 03:59:31 +02:00
### Using an Alternative *zprezto* Directory
[CONTRUBITING] Add section on using a secondary devel directory Add a section on how to use a separate directory than your normal ZDOTDIR for development with its own zprezto.
2017-06-27 00:24:46 +02:00
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 03:59:31 +02:00
To work on Prezto without affecting your current configuration:
[CONTRUBITING] Add section on using a secondary devel directory Add a section on how to use a separate directory than your normal ZDOTDIR for development with its own zprezto.
2017-06-27 00:24:46 +02:00
```sh
mkdir devel-zprezto
cd devel-zprezto
git clone --recursive https://github.com/sorin-ionescu/prezto.git .zprezto
ZDOTDIR=$(pwd)
echo "Your development ZDOTDIR is $ZDOTDIR"
setopt EXTENDED_GLOB
for rcfile in "${ZDOTDIR:-$HOME}"/.zprezto/runcoms/^README.md(.N); do
ln -s "$rcfile" "${ZDOTDIR:-$HOME}/.${rcfile:t}"
done
```
Then to start zsh in this development environment you will run:
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 03:59:31 +02:00
```console
[CONTRUBITING] Add section on using a secondary devel directory Add a section on how to use a separate directory than your normal ZDOTDIR for development with its own zprezto.
2017-06-27 00:24:46 +02:00
ZDOTDIR=/path/to/devel-zprezto zsh
```
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 03:59:31 +02:00
### Modules
[Fix #293] Add CONTRIBUTING.md
2012-09-25 19:12:35 +02:00
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 03:59:31 +02:00
- A *README.md* must be present.
- Large functions must be placed in a *functions* directory.
- Functions that take arguments must have completion.
[Fix #293] Add CONTRIBUTING.md
2012-09-25 19:12:35 +02:00
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 03:59:31 +02:00
### Themes
[Fix #293] Add CONTRIBUTING.md
2012-09-25 19:12:35 +02:00
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 03:59:31 +02:00
- A screenshots section must be present in the file header.
- The pull request description must have [embedded screenshots][6].
[Fix #293] Add CONTRIBUTING.md
2012-09-25 19:12:35 +02:00
[1]: https://github.com/sorin-ionescu/prezto/contributors
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 03:59:31 +02:00
[2]: https://gun.io/blog/how-to-github-fork-branch-and-pull-request
[Fix #293] Add CONTRIBUTING.md
2012-09-25 19:12:35 +02:00
[3]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
[4]: https://help.github.com/articles/using-pull-requests
Remove redundant style rules from CONTRIBUTING.md
2017-06-26 23:40:31 +02:00
[5]: https://google.github.io/styleguide/shell.xml
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 03:59:31 +02:00
[6]: https://github.github.com/gfm/#images
Reference in a new issue Copy permalink