diff options
| -rw-r--r-- | CLI/ruby/README.md | 8 | ||||
| -rw-r--r-- | CONTRIBUTING.md | 9 | ||||
| -rw-r--r-- | LICENSE.md | 2 |
3 files changed, 11 insertions, 8 deletions
diff --git a/CLI/ruby/README.md b/CLI/ruby/README.md index f4ddab7..fd78c30 100644 --- a/CLI/ruby/README.md +++ b/CLI/ruby/README.md @@ -10,7 +10,7 @@ $ gem install terminal_game_of_life ## Usage ```bash -$game-of-life -i https://gitlab.com/a14m.keys --live-cell + +$game-of-life -i https://meta.sr.ht/~a14m.keys --live-cell + $game-of-life -i /path/to/file.txt --height 35 --width 35 $game-of-life -s 1337 --delay 250 ``` @@ -67,6 +67,6 @@ The tag will automatically trigger the release workflow after successful build/t and release the changes to [rubygems.org](https://rubygems.org/gems/terminal_game_of_life) ## Extra information -### [Contributing](https://gitlab.com/a14m/game-of-life/-/blob/master/CONTRIBUTING.md) -### [License](https://gitlab.com/a14m/game-of-life/-/blob/master/LICENSE.md) -### [Code of Conduct](https://gitlab.com/a14m/game-of-life/-/blob/master/CODE_OF_CONDUCT.md) +### [Contributing](../../CONTRIBUTING.md) +### [License](../../LICENSE.md) +### [Code of Conduct](../../CODE_OF_CONDUCT.md) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7a02188..c30b7f2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -13,11 +13,14 @@ Please read these blog posts (which frame the philosophies that we are trying to ## Contribute to the code base -1. Fork this repository to your own account and then clone it to your local device. +1. Clone the repo. 2. Create a new branch `git checkout -b MY_BRANCH_NAME` 3. Install the dependencies based on which language you are modifying (or adding support to). 4. Do your changes. 5. Run the tests bundled with the language. -6. Commit your changes and push them. -7. Create a pull/merge request. +6. Commit your changes. +7. Prepare a patchset (or `git send-email`) 8. Thanks in advance for your contribution :) + +## Report Issues +- Submit a ticket at https://todo.sr.ht/~a14m/game-of-life @@ -1,6 +1,6 @@ The MIT License (MIT) -Copyright (c) 2020- [a14m](https://gitlab.com/a14m) +Copyright (c) 2020- [a14m](https://sr.ht/~a14m) Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal |