Commit Graph

107 Commits

Author SHA1 Message Date
Gregory Anders
73b35ef10f
chore: add default luarc.json for Lua development (#16487)
The Sumneko Lua language server has matured quite a bit and many
Neovim developers use it while working on Neovim. Having a default
configuration for Neovim development is a nice convenience (and
dovetails well with the auto-generated compile_command.json for C
development).

The file is shipped under `contrib` and users can make use of it by
symlinking to `.luarc.json` in the project root.
2021-12-01 12:09:50 -07:00
Christian Clason
3b531d50a8
docs(contrib): recommend nvim --clean #15917 2021-10-05 08:01:09 -07:00
kylo252
09307e64df
fix(docs): uncrustify.cfg location #15817 2021-10-02 14:32:18 -07:00
Dundar Göc
38b0306591 docs: update preferred commit message style for the static analyzer PRs 2021-10-01 21:22:32 +02:00
Dundar Göc
b3b02eb529 docs(CONTRIBUTING.md): how to use uncrustify #15780
close #15780
2021-09-25 18:38:51 -07:00
Justin M. Keyes
9f3679cbfd docs: naming conventions 2021-09-09 06:28:11 -07:00
Justin M. Keyes
81f4de08bd
docs: .git-blame-ignore-revs #15510 2021-08-28 14:00:54 -07:00
Justin M. Keyes
8331cd13c4
docs #15447
- update ":help 'hidden'" #15410
- update ":help K" #15398
- try to capture some of the debug steps from #12036 (bpftrace, USDT probes)
2021-08-21 18:26:33 -07:00
dundargoc
35c6aef1c9
docs: update pull request workflow #15243
The WIP, RFC and RDY stage workflow is outdated and unnecessary. The new
workflow utilize the draft pull request on GitHub.
2021-08-17 05:58:49 -07:00
dundargoc
cad5f01cf3
docs: elaborate on commitlint rules (#15322)
linter requires lowercase at start and no period at end of description
2021-08-09 18:46:33 +02:00
dundargoc
141f0038db
docs: fixed link to label "good-first-issue" (#15239) 2021-08-02 11:01:28 +02:00
Dundar Göc
f54340d488 docs: add description of each type 2021-08-01 14:29:29 +02:00
dundargoc
4547137aaf
chore: use codespell to spell check #15016 2021-07-07 15:28:44 -07:00
Björn Linse
3438959da9
Update CONTRIBUTING.md: mention ASAN/UBSAN for runtime errors 2021-06-30 14:57:52 +02:00
Michael Lingelbach
1df8a34a7b
docs(contributing): update commit message instructions (#14758)
we are changing the way we write commits to increase automation. This commit explains how to write commit messages.
2021-06-10 19:08:58 +02:00
Matthieu Coudron
12cd9e4c08 doc: link wiki on how to improve/build doc
We generate some part of the doc from lua which complexifies the process a bit so we've added a wiki page explaining this.
2021-01-27 21:15:52 +01:00
James McCoy
86eba08a4b
build: Rename TRAVIS_CI_BUILD variable to CI_BUILD 2020-11-13 13:36:56 -05:00
Björn Linse
406464fa6e
CONTRIBUTING.md: mention "good first issue" label 2020-01-29 12:06:35 +01:00
Justin M. Keyes
9231684986
doc [ci skip] #11656 2020-01-12 23:41:55 -08:00
Justin M. Keyes
019c8d13dd
build/doc/CI: remove/update quickbuild references #11258 2019-10-19 18:04:08 -07:00
Justin M. Keyes
afef973262
doc [ci skip] #10383
- test/README.md: document luassert `TableFormatLevel`
- CONTRIBUTING.md: absorb parts of the old "Development tips" wiki page
2019-07-19 21:32:04 +02:00
Justin M. Keyes
c70c8b607f doc [ci skip] #9478
- Lua
- developer guidelines
- MAINTAIN.md
- TUI: cleanup
- TUI: mention Windows terminfo builtins
- cleanup if_pyth, redirect python-bindeval tag

Helped-by: Björn Linse <bjorn.linse@gmail.com>
Helped-by: erw7 <erw7.github@gmail.com>
2019-01-26 20:38:14 +01:00
Justin M. Keyes
eaabec459a doc: CONTRIBUTING.md 2019-01-08 22:50:43 +01:00
Justin M. Keyes
f72f638f97 doc: job/channel, misc #7783
doc: termios defaults. ref #6992
doc: :help shell-powershell
doc: provider: Python minimum version is 2.7, 3.4
doc: remove :!start special-case. #5844
doc: mention #7917 change which accepts empty Array for Dictionary parameter
doc: <Cmd> pseudokey
doc: lmap change #5658
doc: -s, -es
2018-06-11 00:08:27 +02:00
Justin M. Keyes
ad9c2d3cb9 doc
closes #7622
2017-12-10 17:13:22 +01:00
Justin M. Keyes
dc3c06e73d doc: how to enable ASan/UBSan 2017-07-29 18:51:54 +02:00
Justin M. Keyes
3c2640cce4 doc 2017-07-29 14:21:58 +02:00
Justin M. Keyes
bc025ab117 doc: *standard-path*, *$NVIM_LOG_FILE* 2017-06-07 00:40:13 +02:00
Justin M. Keyes
45d92e2563 doc: clang scan-build 2017-06-06 04:03:24 +02:00
Justin M. Keyes
872465cf1d doc 2017-05-21 00:01:52 +02:00
ZyX
b4f0586596 CONTRIBUTING.md: Fix ri alias 2017-05-08 21:28:41 +03:00
Justin M. Keyes
6bc6d94ec8 doc: api-contract, CONTRIBUTING.md 2017-04-19 13:48:12 +02:00
Nikolai Aleksandrovich Pavlov
29ab8c1ae2 doc/CONTRIBUTING.md: Recommend merge-based workflow.
References #6435
2017-04-19 04:03:09 +02:00
Justin M. Keyes
3803314f78 doc: QuickBuild 2017-01-31 08:58:43 +01:00
Anmol Sethi
4d253b4df5 doc: CONTRIBUTING.md (#5239) 2016-08-23 23:49:09 -04:00
Justin M. Keyes
db375102ea doc 2016-08-10 00:47:17 -04:00
Justin M. Keyes
b3b25c2490 doc: precision, concision, elision
Single point of truth (SPOT): Do not sprinkle "contributing" guidelines
across various resources; CONTRIBUTING.md is the authority.

DRY: Do not repeat guidelines in CONTRIBUTING.md which are covered by
ISSUE_TEMPLATE.md
2016-06-03 17:11:10 -04:00
Michael Reed
94fabe4d59 CONTRIBUTING.md: Remove outdated info
- Remove mention of "build-issues" and "runtime-issues" sections from
  the "Troubleshooting" page; they're already mentioned at the top of
  the section: "Before reporting an issue, see the ...".

- As of [1], clint-ignored-files.txt isn't used anymore.

[1]: 57eaefbb23
2016-01-08 17:47:09 -05:00
Michael Reed
eea072690b CONTRIBUTING.md: Fix broken sentence 2015-11-26 16:28:35 -05:00
Marco Hinz
85b1052c3c Remove all invalid nvimrc and ngvimrc references
"vimrc" refers to all files that are used to configure Neovim. The main
configuration file is init.vim nowadays.

All nvimrc references that are left refer to a local ".nvimrc" which is read
if 'exrc' is set. ".ngvimrc" references were completely wiped.

Closes #3552.
2015-11-11 22:50:14 +01:00
Justin M. Keyes
68e5968568 doc: Remove CLA requirement.
Closes #3036
2015-10-27 01:07:24 -04:00
Michael Reed
dac8bcd090 CONTRIBUTING.md: Fix broken links #2702
The wiki has had a dedicated "Troubleshooting" page for a while now.
2015-05-19 17:06:22 -04:00
Michael Reed
c68fcb6ea1 CONTRIBUTING: Mention the wiki's troubleshooting & FAQ articles
[ci skip]
2015-04-21 19:05:27 -04:00
Thiago de Arruda
84891f2802 Change neovim.org references to neovim.io 2015-04-19 17:17:45 -03:00
Michael Reed
82d2b8a45f CONTRIBUTING.md: Review
Helped-by: Florian Walch <florian@fwalch.com>
Helped-by: oni-link <knil.ino@gmail.com>
2015-04-01 13:46:54 -04:00
Michael Reed
97df129956 CONTRIBUTING.md: Misc improvements
- In general, many sections have been expanded a lot.
- Defer to the wiki when it makes sense.
- Rewrite a bunch of things to be clearer. There is a lot more
  verbosity, but clarifying as many items as we can in this document is
  preferable to it being done later in the issue tracker.

(alphabetically sorted)
Helped-by: David Granström <david@davidgranstrom.com>
Helped-by: Florian Walch <florian@fwalch.com>
Helped-by: John Szakmeister <john@szakmeister.net>
Helped-by: Justin M. Keyes <justinkz@gmail.com>
Helped-by: Martin Kopischke <martin@kopischke.net>
Helped-by: oni-link <knil.ino@gmail.com>

[ci skip]
2015-03-27 22:53:52 -04:00
Felipe Morales
6425627c3f tools: add .clang-format
Configuration for clang-format and related utilities.

Examples:

    clang-format -style=file <file>
    git clang-format -style=file <commit>
    git diff -U0 HEAD^ | clang-format-diff.py -i -p1 -style=file
2015-01-26 21:10:14 -03:00
Florian Walch
89cccf2826 CONTRIBUTING.md: Add link to CLA. 2014-10-31 10:52:57 +01:00
Kartik Agaram
a62998ea08 CONTRIBUTING.md: more guidance on cosmetic changes #1346 2014-10-30 05:58:40 +00:00
Justin M. Keyes
062402fb64 Update CONTRIBUTING.md and README.md #740
- recommend task/subtask convention for commit messages
2014-08-26 03:30:16 -04:00
Justin M. Keyes
e1264412f8 update style guide URL 2014-06-23 17:44:12 -04:00
Josh Davis
f3dda65de1 Update CONTRIBUTING.md with current info
- Finish what @ashleyh started.
- Add section for Getting Started with Neovim.
- Add section for commit messages.
- Trim down on wording to keep it short.
2014-05-08 16:58:15 -05:00
aph
b9cb2332d3 update CONTRIBUTING.md 2014-05-07 21:18:57 -05:00
Chris Watkins
c3fb8240bc Add the neovim style guide to the contributing guide. 2014-04-24 10:50:50 -03:00
David Z. Chen
6121d9b500 Issue #66 - Add lint tool and uncrustify config. Update contributing documentation on coding style. 2014-03-05 16:50:27 -03:00
Ashley Hewson
8cb10e8641 CONTRIBUTING.md: mention coding style 2014-03-01 16:18:54 +00:00
jbranchaud
b7d5edd5aa Rebased the following three commits onto one another:
1. Following GitHub convention by adding a CONTRIBUTING.md file.

2. Linking to the wiki page for communicating.

3. Referencing the waffle.io page for Neovim.
2014-02-25 15:59:57 -03:00