f18d8888ba
Clean up the pre-commit config
...
Removal of unneeded files / file types
Clean up the repo root folder by moving `codespell.txt`
2024-03-16 20:03:21 +10:00
9b4046f479
Merge pull request #5961 from jbampton/add-docker
...
Add `Docker` to build and run all `mruby` tests. Run `pre-commit` and generate `YARD` docs with Docker
2023-05-05 22:42:33 +09:00
06a765a1c2
Change MRuby to mruby
2023-05-03 22:12:59 +10:00
00d43ad960
Add Docker to build and run all mruby tests
...
Run `pre-commit` and generate `YARD` docs with Docker
Update CONTRIBUTING
2023-04-13 00:12:32 +10:00
2559c93b2b
Remove misspell and update CONTRIBUTING.md
...
It looks like `misspell` is no longer maintained and
the last commit was on `Mar 9, 2018`.
We already run `codespell` and it is an active project
with the last commit 5 days ago.
Also updated the CONTRIBUTING guide with more
information on `pre-commit` as well as listed `codespell`
as the spell checker.
https://github.com/codespell-project/codespell
https://github.com/client9/misspell
https://github.com/client9/misspell/issues/197
2023-03-01 17:49:39 +10:00
d318e992ea
Use rubygems.org links for yard-mruby and yard-coderay
...
The RubyGems website gives a much better overview of both Gems
A lot more quick links and statistics.
https://rubygems.org/gems/yard-mruby
https://rubygems.org/gems/yard-coderay
2022-12-30 12:39:54 +10:00
6da82230e8
Add more building documentation
2022-12-30 11:14:12 +10:00
42946fed8f
CONTRIBUTING.md: update pre-commit info with make and rake
2022-12-29 14:46:58 +10:00
696226a60e
docs: standardize Markdown lists
...
Previously for lists we were using both `*` and `-` to start the list items.
This pr changes all lists to use `-`.
2022-10-26 13:09:41 +10:00
8f16c1d99e
docs: add link and fix command
2022-06-27 15:30:17 +10:00
9841980bce
Add docs on the SKIP pre-commit environment variable
...
Knowing about `SKIP` is useful
https://pre-commit.com/#temporarily-disabling-hook
2022-06-27 14:01:14 +10:00
c9db3ec7c3
Style the CONTRIBUTING guide
2021-07-07 22:26:19 +10:00
625210f67c
Enable markdownlint rule MD046 code-block-style
...
Fix C Markdown code block style
2021-06-19 08:38:58 +10:00
d08ea8a92c
Standardize commands inside backticks
...
Remove whitespace
2021-06-17 12:02:21 +10:00
f4d9a9beec
Add documentation on spell checking with misspell
2021-05-04 09:16:22 +10:00
9d32d440eb
feat(CI): add the GitHub Super Linter
...
The GitHub Super Linter is a more robust and better supported
tool than the current GitHub Actions we are using.
Running these checks:
ERROR_ON_MISSING_EXEC_BIT: true
VALIDATE_BASH: true
VALIDATE_BASH_EXEC: true
VALIDATE_EDITORCONFIG: true
VALIDATE_MARKDOWN: true
VALIDATE_SHELL_SHFMT: true
VALIDATE_YAML: true
https://github.com/marketplace/actions/super-linter
https://github.com/github/super-linter
Added the GitHub Super Linter badge to the README.
Also updated the pre-commit framework and added
more documentation on pre-commit.
Added one more pre-commit check: check-executables-have-shebangs
Added one extra check for merge conflicts to our
GitHub Actions.
EditorConfig and Markdown linting.
Minor grammar and spelling fixes.
Update linter.yml
2021-04-16 16:37:52 +09:00
1c9b1bfeb7
feat: add pre-commit framework
2021-03-01 10:06:17 +10:00
f3d5deb981
Clarify that contributors agree with MIT license in CONTRIBUTING.md.
2021-01-26 18:21:49 +09:00
f7c5c00d6e
🔒 Fix missing HTTPS on links
2020-12-19 17:36:39 +10:00
734f6b1cc4
Remove 2 restrictions from CONTRIBUTING.md; close #5159
...
* Allow mixed declarations, especially loop variables
* Allow C++ style commends `//`
2020-11-21 16:55:40 +09:00
10b1a52bb8
Small updates on documents:
...
- README.md
- CONTRIBUTING.md
- doc/limitations.md
2020-10-12 16:20:48 +09:00
de17f63b45
Abandon minirake. Use rake for compilation; fix #4884
2019-12-21 22:11:08 +09:00
1c1ebb1833
Refine documentation for C99 compliance; ref #4685 [ci skip]
...
The refinement was based on comment from @matz.
2019-09-10 16:49:14 +09:00
dcc316d3b8
Fix typos in documentation and error messages [skip ci]
2015-06-19 15:52:23 +03:00
b7fc0f95e5
Wrap CONTRIBUTING.md to 80 columns
2014-09-21 11:07:36 +09:00
954867828b
Add a caution to Your Pull Request document.
2014-07-03 08:27:18 +09:00
cdc1c5b5d0
Fix styleguide based on @cremno's input
2013-03-01 01:19:10 +08:00
f6c9e40d48
Modification of CONTRIBUTING.md
...
Some minor fixes of the CONTRIBUTING.md file.
2013-03-01 00:34:05 +08:00
5e16c2309f
re-formulate some sentences
2012-09-18 22:20:05 +09:00
2493915a72
Emphasis commands
2012-09-18 21:38:15 +09:00
fcf38cc86b
Add a contribution information file
2012-09-18 21:36:00 +09:00
John Bampton