|
|
@@ -1,7 +1,7 @@
|
|
|
# Contributing to ScriptShifter
|
|
|
|
|
|
All contributions to ScriptShifter are done via the Git repository at
|
|
|
-[https://github.com/lcnetdev/scriptshifter].
|
|
|
+https://github.com/lcnetdev/scriptshifter.
|
|
|
|
|
|
Most scripts can be handled simply via editing script tables, which does not
|
|
|
require any programming skills, but requires an understanding of how the
|
|
|
@@ -16,15 +16,15 @@ tables:
|
|
|
- Read the [configuration documentation](./config.md) first, which should
|
|
|
provide the necessary understanding of ScriptShifter tables.
|
|
|
- Open a new issue by clicking the "New issue" button in
|
|
|
- [https://github.com/lcnetdev/scriptshifter/issues]. Describe clearly and
|
|
|
+ https://github.com/lcnetdev/scriptshifter/issues. Describe clearly and
|
|
|
concisely the need for the changes you want to commit. IMPORTANT: if you have
|
|
|
multiple items to resolve, such as more than one major area of a script or
|
|
|
multiple scripts, open one issue for each, and commit one set of changes per
|
|
|
issue.
|
|
|
- If you are modifying an existing table, navigate on Github to the table in
|
|
|
- question (in [../scriptshifter/tables/data]) while logged into Github, and
|
|
|
- click on the pencil button on the right on top of the code to edit the file
|
|
|
- in place.
|
|
|
+ question in the [data folder](../scriptshifter/tables/data) while logged into
|
|
|
+ Github, and click on the pencil button on the right on top of the code to
|
|
|
+ edit the file in place.
|
|
|
- You can perform as many edits as you like within a branch. Just keep adding
|
|
|
until you are satisfied. Just remember to keep the scope of the PR specific
|
|
|
to the one issue you are resolving.
|
|
|
@@ -33,10 +33,10 @@ tables:
|
|
|
- If you are changing rules in a script table, or adding a whole new table,
|
|
|
please add sample strings to the test table (see detailed instructions
|
|
|
below).
|
|
|
-- Replace the generic commit message with an informative message about what
|
|
|
- you did. Please be concise and clear. In the "Extended description" field,
|
|
|
- enter `Fixes #<issue ID>`, where `<issue ID>` is the identifier of the issue
|
|
|
- you opened earlier (it shows in the title).
|
|
|
+- Replace the generic commit message with an informative message about what you
|
|
|
+ did. Please be concise and clear. In the "Extended description" field, enter
|
|
|
+ `Fixes #<issue ID>`, where `<issue ID>` is the identifier of the issue you
|
|
|
+ opened earlier (it shows in the title).
|
|
|
- From the radio button at the bottom, select "create a new branch" if not
|
|
|
already selected. Leave the provided branch name if you can't come up with a
|
|
|
better one.
|
|
|
@@ -45,12 +45,13 @@ tables:
|
|
|
live service).
|
|
|
- (Note: the steps up to here may be achieved by different means if you are
|
|
|
familiar with code editors and Git).
|
|
|
-- Go to the pull request and request a review from at least one of
|
|
|
- `@thisismattmiller`, `@kefo`, or `@scossu`. The pull request will be reviewed
|
|
|
- and may be accepted, or sent back to you for edits (normally with clear
|
|
|
- indications of what needs to be changed).
|
|
|
-- If you are requested edits, keep adding edits to the same PR and re-request
|
|
|
- a review when you think you satisfied your reviewers' comments.
|
|
|
+- Go to your pull request in the [PR
|
|
|
+ page](https://github.com/lcnetdev/scriptshifter/pulls) and request a review
|
|
|
+ from at least one of `@thisismattmiller`, `@kefo`, or `@scossu`. The pull
|
|
|
+ request will be reviewed and may be accepted, or sent back to you for edits
|
|
|
+ (normally with clear indications of what needs to be changed).
|
|
|
+- If you are requested edits, keep adding edits to the same PR and re-request a
|
|
|
+ review when you think you satisfied your reviewers' comments.
|
|
|
- After the request is approved, you can merge it into the main branch using
|
|
|
the button present in the PR page, if someone hasn't done that already.
|
|
|
- At this point, your job is done, but the code must still be deployed to the
|
|
|
@@ -60,11 +61,11 @@ tables:
|
|
|
|
|
|
## Adding test strings
|
|
|
|
|
|
-Adding strings to the [test table](tests/data/sample_strings.csv) is the single
|
|
|
-most important thing to do, after your contribution, to keep ScriptShifter
|
|
|
-free from error and well-maintained. This table is used as a source of test
|
|
|
-strings by the automated tests that run before deploying a new version of
|
|
|
-ScriptShifter.
|
|
|
+Adding strings to the [test table](../tests/data/sample_strings.csv) is the
|
|
|
+single most important thing to do, after your contribution, to keep
|
|
|
+ScriptShifter free from error and well-maintained. This table is used as a
|
|
|
+source of test strings by the automated tests that run before deploying a new
|
|
|
+version of ScriptShifter.
|
|
|
|
|
|
If you modify in any way rules in a table (almost certainly), or even add a
|
|
|
whole new script table, you will want to verify that your changes work as
|
