Streamline developer documentation #6107
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
johnsaigle
added
Cleanup
johnsaigle
commented
Feb 25, 2020
| @@ -1,24 +1,22 @@ | |||
| # General Formatting | |||
| - Indentation should be 4 spaces instead of tabs | |||
There was a problem hiding this comment.
I think this is covered differently by different files. In general this will be caught by static analysis now.
johnsaigle
commented
Feb 25, 2020
| # SQL | ||
| * Prepared statements MUST be used for any statements which involve user input. |
There was a problem hiding this comment.
This is more of a PHP thing since that's how the commands are written.
johnsaigle
commented
Feb 25, 2020
| - Javascript should never be mixed with HTML or PHP code. | ||
| - Javascript should go into `modules/js/` | ||
| - Any newly written JavaScript should pass ESLint with default options. | ||
| - Compiled JavaScript should not be tracked by Git so make use of .gitignore |
There was a problem hiding this comment.
These points are covered in the new module guide #6048 and is more appropriate there.
johnsaigle
commented
Feb 25, 2020
PapillonMcGill
suggested changes
Mar 2, 2020
add syntax highlighting Co-Authored-By: PapillonMcGill <[email protected]>
maltheism
pushed a commit
to maltheism/Loris
that referenced
this pull request
Apr 7, 2020
Modifies some of our developer documentation to be up-to-date and less repetitive. Moves some sections around so that they are in a more appropriate place. Resolves aces#4390
laemtl
pushed a commit
to laemtl/Loris
that referenced
this pull request
Jun 10, 2020
Modifies some of our developer documentation to be up-to-date and less repetitive. Moves some sections around so that they are in a more appropriate place. Resolves aces#4390
laemtl
pushed a commit
to laemtl/Loris
that referenced
this pull request
Jun 16, 2020
Modifies some of our developer documentation to be up-to-date and less repetitive. Moves some sections around so that they are in a more appropriate place. Resolves aces#4390
AlexandraLivadas
pushed a commit
to AlexandraLivadas/Loris
that referenced
this pull request
Jun 29, 2021
Modifies some of our developer documentation to be up-to-date and less repetitive. Moves some sections around so that they are in a more appropriate place. Resolves aces#4390
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Brief summary of changes
Modifies some of our developer documentation to be up-to-date and less repetitive. Moves some sections around so that they are in a more appropriate place.
Resolves #4390 (With some parts of that issue being handled by #6105)