diff options
| author | Miquel Sabaté Solà <mssola@mssola.com> | 2026-07-21 22:41:12 +0200 |
|---|---|---|
| committer | Miquel Sabaté Solà <mssola@mssola.com> | 2026-07-21 22:41:12 +0200 |
| commit | d6be417dd5107f74e1ba74ef5794beac174b0c52 (patch) | |
| tree | 0330b898187e2e95fafea64340a3fdf9da4d0fd1 | |
| parent | aafa3e91b10f9f8586435b8340160453a09ee836 (diff) | |
| download | g-d6be417dd5107f74e1ba74ef5794beac174b0c52.tar.gz g-d6be417dd5107f74e1ba74ef5794beac174b0c52.zip | |
Update links
That is, remove severely outdated stuff like CI that never quite worked,
and add a link to my contribution guidelines.
Signed-off-by: Miquel Sabaté Solà <mssola@mssola.com>
| -rw-r--r-- | CONTRIBUTING.md | 1 | ||||
| -rw-r--r-- | CONTRIBUTING.org | 61 | ||||
| -rw-r--r-- | README.md | 15 |
3 files changed, 1 insertions, 76 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..cdbd66a --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1 @@ +See my [contribution guidelines](https://jo.mssola.com/en/contributing.html). diff --git a/CONTRIBUTING.org b/CONTRIBUTING.org deleted file mode 100644 index 5c1a199..0000000 --- a/CONTRIBUTING.org +++ /dev/null @@ -1,61 +0,0 @@ -#+STARTUP:showall - -* Contributing - -** Running tests - -Just run: - -#+BEGIN_SRC bash -$ make test -#+END_SRC - -*** Git validation - -In order to ensure that the git log is as maintainable as possible, the -[[https://github.com/vbatts/git-validation][git-validation]] tool is used. You can install this tool by running: - -#+BEGIN_SRC bash -$ go get -u github.com/vbatts/git-validation -#+END_SRC - -If you already have this tool installed, then simply perform: - -#+BEGIN_SRC bash -$ make git-validation -#+END_SRC - -Note that if you don't have this tool installed the task will do nothing (it -will just print a help message). This is done so when running the default make -task this doesn't interrupt it. This task is already called by the default -=test= one. - -*** Shellcheck - -This project uses [[https://github.com/koalaman/shellcheck][shellcheck]] in order to validate the code style. In order to -run =shellcheck=, just perform: - -#+BEGIN_SRC bash -$ make shellcheck -#+END_SRC - -** Issue reporting - -I'm using [[https://github.com/mssola/writer-mode][Github]] in order to host the code. Thus, in order to report issues you -can do it on its [[https://github.com/mssola/writer-mode/issues][issue tracker]]. A couple of notes on reports: - -- Check that the issue has not already been reported or fixed in =master=. -- Try to be concise and precise in your description of the problem. -- Provide a step by step guide on how to reproduce this problem. -- Provide the version you are using (the commit SHA, if possible). - -** Pull requests - -- Write a [[https://chris.beams.io/posts/git-commit/][good commit message]]. -- Make sure that tests are passing on your local machine (it will also be - checked by the CI system whenever you submit the pull request). -- Update the [[./CHANGELOG.org][changelog]]. -- Try to use the same coding conventions as used in this project. -- Open a pull request with *only* one subject and a clear title and - description. Refrain from submitting pull requests with tons of different - unrelated commits. @@ -1,10 +1,3 @@ -<p align="center"> - <a href="https://github.com/mssola/g/actions?query=workflow%3ACI" title="CI status for the main branch"><img src="https://github.com/mssola/g/workflows/CI/badge.svg" alt="Build Status for main branch" /></a> - <a href="http://www.gnu.org/licenses/gpl-3.0.txt" rel="nofollow"><img alt="License GPL 3" src="https://img.shields.io/badge/license-GPL_3-blue.svg" style="max-width:100%;"></a> -</p> - ---- - This repository holds a very humble and simple script that handles shortcuts of bash paths. For example: @@ -38,14 +31,6 @@ I guess that the commands above are quite self-explanatory. Just place the `g.sh` and the `gcompletion.sh` files wherever you want and then add a `source` command for both of the files in the `.bashrc` file. -## Contributing - -Read the [CONTRIBUTING.org](./CONTRIBUTING.org) file. - -## [Changelog](https://pbs.twimg.com/media/DJDYCcLXcAA_eIo?format=jpg&name=small) - -Read the [CHANGELOG.org](./CHANGELOG.org) file. - ## License ```txt |
