Permalink
Browse files

CONTRIBUTING: Update Links, misc

Update links; skip redirect, use HTTPS, remove link to now defunct forums, add links to SQF syntax highlighters, etc.

Miscellaneous changes
  • Loading branch information...
Jawshy committed Oct 6, 2017
1 parent f17b260 commit f44a57679e26218ffa186f549fcb0a7038ad4ab7
Showing with 7 additions and 8 deletions.
  1. +7 −8 .github/CONTRIBUTING.md
View
@@ -14,7 +14,7 @@ Contributing to AsYetUntitled
#### Before creating a new issue make sure to...
* **...check that the issue you are reporting does not already exist.**
* If it does exist and it is still open then you may wish to add more information to that issue in a comment.
* If it does exist but it has been closed then comment on **that** issue instead of creating a new one. An [organisation member](https://github.com/AsYetUntitled) will then decide if the issue needs to be reopened.
* If it does exist but it has been closed then comment on **that** issue instead of creating a new one. An [organisation member](https://github.com/orgs/AsYetUntitled/people) will then decide if the issue needs to be reopened.
* **...check that you are using the latest files from the master branch.**
* If your files are behind then it is possible that the issue you are reporting has already been fixed in a recent commit.
* **...check that you have not modified the files from what is on the repository.**
@@ -44,12 +44,11 @@ Contributing to AsYetUntitled
* See [assigning issues and pull requests to other GitHub users](https://help.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/).
## Pull Requests
* If your pull request fixes an existing issue then be sure to associate your pull request with the issue. This means that if your pull request is merged then the corresponding issue will automatically be closed. See [closing issues via commit messages](https://help.github.com/articles/closing-issues-via-commit-messages/) for what keywords to use.
* If your pull request fixes an existing issue then be sure to associate your pull request with the issue. This means that if your pull request is merged then the corresponding issue will automatically be closed. See [closing issues via commit messages](https://help.github.com/articles/closing-issues-using-keywords/) for what keywords to use.
* If your pull request fixes an issue that has not been reported then be sure to clearly specify the fix in your pull request message.
* If your pull request adds a new feature to the mission then...
* ...decide if the mission would actually benefit from your new feature. You may wish to create an issue to discuss the implementation of your feature with other contributors.
* ...if others think that your feature should be implemented then go ahead and submit a pull request.
* ...if not then instead consider posting a tutorial on the [ArmA RPG Life forums](https://armarpglife.com/forums/) on how to implement it.
* ...be sure to thoroughly test your code for any errors and, if applicable, possible exploits.
* ...optimise your code to have as little impact on performance as possible. See [code optimisation](https://community.bistudio.com/wiki/Code_Optimisation) on the Bohemia Interactive Wiki for more information.
* ...if applicable, be sure to update the [BattlEye filters](https://github.com/AsYetUntitled/Framework/tree/master/BEFilters) and [SpyGlass variables](https://github.com/AsYetUntitled/Framework/blob/master/Altis_Life.Altis/config/Config_SpyGlass.hpp) to be compatible with your changes. If you are unsure on how to do so then ask if someone else would be kind enough to do so for you.
@@ -58,18 +57,18 @@ Contributing to AsYetUntitled
### Help! The Travis CI build failed!
* If the Travis CI build on your pull request fails then Travis may have detected a syntax error in the code. Click "Show all checks" near the bottom of your pull request and then click "Details" next to the check that failed. Search for "ERROR" to find what is causing the check to fail.
* If the error is...
* ...possible missing white space after if detected then you need to add a space after the `if`.
* ..."possible missing white space after if detected" then you need to add a space after the `if`.
* Example: `if (condition) then { code } else { code }`
* ...possible missing [round/square/curly] [bracket/brace] detected then check the syntax of your code. An [SQF syntax highlighter](https://www.google.com.au/search?q=SQF+syntax+highlighter&rlz=1C1ASRM_enAU584AU584&oq=SQF+syntax+highlighter&aqs=chrome..69i57.620j0j7&sourceid=chrome&ie=UTF-8) may be useful.
* ...possible missing semi-colon detected then add a `;` where it is needed.
* ...tab detected then you need to indent with four (4) spaces for each one (1) tab.
* ..."possible missing [round/square/curly] [bracket/brace] detected" then check the syntax of your code. A syntax highlighter for the SQF language may be helpful. Syntax highlighting is available for [Notepad++](http://www.armaholic.com/page.php?id=8680&highlight=SQF%2BSYNTAX%2BHIGHLIGHTING) and [Atom](https://atom.io/packages/search?utf8=%E2%9C%93&q=language+arma+atom&commit=Search).
* ..."possible missing semi-colon detected" then add a `;` where it is needed.
* ..."tab detected" then you need to indent with four (4) spaces for each one (1) tab.
## Can I help?
* If you are competent in any of the below then you have what it takes to help us expand and improve upon this framework.
* [SQF](https://community.bistudio.com/wiki/SQF_syntax) - Scripting.
* [SQL](https://en.wikipedia.org/wiki/SQL) - Database structure.
* [C++](https://en.wikipedia.org/wiki/C%2B%2B) - Configs and [dialogs](https://community.bistudio.com/wiki/Dialog_Control).
* [Regular expressions](http://www.regular-expressions.info/) (Regex) - Enhanced [BattlEye filter](https://github.com/AsYetUntitled/Framework/tree/master/BEFilters) functionality.
* [Regular expressions](https://www.regular-expressions.info/) (Regex) - Enhanced [BattlEye filter](https://github.com/AsYetUntitled/Framework/tree/master/BEFilters) functionality.
* English, Czech, French, Spanish, Italian, Polish, Portuguese, Russian, or German - [Stringtable](https://community.bistudio.com/wiki/Stringtable.xml) localisation.
* If not, but you can setup and run your own server, then you can help us test the build for bugs, exploits, security and performance issues.
* See [issues](https://github.com/AsYetUntitled/Framework/issues) for a full list of all open tasks and bugs. If you would like to work on a solution to an issue then please leave a comment on that issue so that others know a solution is in progress.

0 comments on commit f44a576

Please sign in to comment.