From 49886620c4241d27164f3cac1c26c349eefe27a0 Mon Sep 17 00:00:00 2001 From: Noah Gorny Date: Tue, 29 Dec 2020 21:58:47 +0200 Subject: [PATCH 1/3] docs: contributing: Mention github actions instead of travis --- docs/contributing.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/contributing.rst b/docs/contributing.rst index 0f0d1299..fcfeb211 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -59,8 +59,8 @@ Unit Tests When adding features or making changes/fixes, please run our growing unit test suite to ensure that you did not break existing functionality. The test suite does not cover all aspects of Bash-it, but please run it anyway to verify that you did not introduce any regression issues. -Any code pushed to GitHub as part of a Pull Request will automatically trigger a continuous integration build on `Travis CI `_\ , where the test suite is run on both Linux and macOS. -The Pull Request will then show the result of the Travis build, indicating whether all tests ran fine, or whether there were issues. +Any code pushed to GitHub as part of a Pull Request will automatically trigger a continuous integration build on `GitHub Actions `_\ , where the test suite is run on both Linux and macOS. +The Pull Request will then show the result of the CI build, indicating whether all tests ran fine, or whether there were issues. Please pay attention to this, Pull Requests with build issues will not be merged. Adding new functionality or changing existing functionality is a good opportunity to increase Bash-it's test coverage. From aeb0cb73535b7f9c11cc59963bb475b19343b269 Mon Sep 17 00:00:00 2001 From: Noah Gorny Date: Tue, 29 Dec 2020 22:05:26 +0200 Subject: [PATCH 2/3] docs: contributing: Add section about invoking with command builtin --- docs/contributing.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/contributing.rst b/docs/contributing.rst index fcfeb211..004723df 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -42,6 +42,8 @@ Code Style * When changing existing files, consider also adding them into `clean_files.txt` and fixing the linting errors that arise. See :ref:`linting_your_changes` for more information. * Indentation is using tabs, not spaces. Most of the code is indented with 2 spaces, some with 4 spaced tabs. Please try to stick to tabs. If you're using an editor that supports `EditorConfig `_\ , the editor should automatically use the settings defined in Bash-it's `.editorconfig file <.editorconfig>`_. +* Prefer to invoke commands directly using the ``command`` shell builtin. This way, your code + will always execute the command you wanted and not an alias/function that overrides the name of the command. (For example, use ``command rm`` instead of ``rm``) * When creating new functions, please use a dash ("-") to separate the words of the function's name, e.g. ``my-new-function``. Don't use underscores, e.g. ``my_new_function``. * Internal functions that aren't to be used by the end user should start with an underscore, e.g. ``_my-new-internal-function``. From 3c0235b44b5da8be4a9dce5da5a6c05fd5345fa3 Mon Sep 17 00:00:00 2001 From: Noah Gorny Date: Tue, 29 Dec 2020 22:05:54 +0200 Subject: [PATCH 3/3] docs: contributing: Remove bullets already covered by our templates --- docs/contributing.rst | 5 ----- 1 file changed, 5 deletions(-) diff --git a/docs/contributing.rst b/docs/contributing.rst index 004723df..79d8ed1c 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -10,11 +10,6 @@ Issues ------ -* When opening a new issue in the issue tracker, please include information about which *Operating System* you're using, and which version of *Bash*. -* In many cases, it also makes sense to show which Bash-it plugins you are using. - This information can be obtained using ``bash-it show plugins``. -* If the issue happens while loading Bash-it, please also include your ``~/.bash_profile`` or ``~/.bashrc`` file, - as well as the install location of Bash-it (default should be ``~/.bash_it``\ ). * When reporting a bug or requesting a new feature, consider providing a Pull Request that fixes the issue or can be used as a starting point for the new feature. Don't be afraid, most things aren't that complex...