|
|
@@ -13,8 +13,8 @@ For non-developers who want to improve, fix issues, or add whole new script
|
|
|
tables:
|
|
|
|
|
|
- You need a Github account to perform any edits to the code.
|
|
|
-- Read [doc/config.md] first, which should provide the necessary understanding
|
|
|
- of ScriptShifter 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
|
|
|
concisely the need for the changes you want to commit. IMPORTANT: if you have
|
|
|
@@ -22,9 +22,9 @@ tables:
|
|
|
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 [../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.
|
|
|
@@ -49,10 +49,10 @@ tables:
|
|
|
`@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 request edits, keep adding edits to the same PR and re-request
|
|
|
+- 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 to the main branch using the
|
|
|
- button present in the PR page, if someone hasn't done that already.
|
|
|
+- 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
|
|
|
live service. Please coordinate with the repository managers (Matt or Kevin)
|
|
|
if you don't see your changes reflected in Marva within a day or two.
|
|
|
@@ -60,7 +60,7 @@ tables:
|
|
|
|
|
|
## Adding test strings
|
|
|
|
|
|
-Adding string to the [test table](tests/data/sample_strings.csv) is the single
|
|
|
+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
|
|
|
@@ -80,6 +80,10 @@ script, and table key values. It is important to add the table key on column C,
|
|
|
because without that, tests won't run for that script.
|
|
|
|
|
|
If you edited the file with a spreadsheet editor, make sure you export the
|
|
|
-fileas CSV (and not as Excel or LiberOffice). Then, go back to the branch that
|
|
|
-you opened your PR on, navigate to the original file, and replacethe file with
|
|
|
+file as CSV (and not as Excel or LibreOffice). Then, go back to the branch that
|
|
|
+you opened your PR on, navigate to the original file, and replace the file with
|
|
|
your CSV.
|
|
|
+
|
|
|
+You can (and should) perform these edit within the same PR in which you are
|
|
|
+making changes to the same script. You can also create a new PR just to add
|
|
|
+more test strings, which is a wonderful thing to do.
|
