Default resources - Contributing - Revision history

Fernando187: Fix link

2024-07-20T14:22:16Z

Fix link

← Older revision		Revision as of 14:22, 20 July 2024
Line 1:		Line 1:
	This page is related to the [https://github.com/multitheftauto/mtasa-resources mtasa-resources] project. Read more about it here: [[Default resources]]		This page is related to the [https://github.com/multitheftauto/mtasa-resources mtasa-resources] project. Read more about it here: [[Default resources]]

	The guide on how to Contribute to the project is available at https://github.com/multitheftauto/mtasa-docs/blob/main/CONTRIBUTING.md		The guide on how to Contribute to the project is available at https://github.com/multitheftauto/mtasa-docs/blob/main/mtasa-resources/CONTRIBUTING.md

	[[Category: Development]]		[[Category: Development]]

Fernando187: Doc moved to gitbub

2024-07-20T14:15:49Z

Doc moved to gitbub

@@ Line 1: / Line 1: @@
 This page is related to the [https://github.com/multitheftauto/mtasa-resources mtasa-resources] project. Read more about it here: [[Default resources]]
-{{Note|This article is currently '''Work In Progress'''}}
+The guide on how to Contribute to the project is available at https://github.com/multitheftauto/mtasa-docs/blob/main/CONTRIBUTING.md
 [[Category: Development]]

Fernando187: WIP note

2024-07-04T09:22:21Z

WIP note

← Older revision		Revision as of 09:22, 4 July 2024
Line 1:		Line 1:
	~~<p><strong>Work in Progress</strong> -~~ This page is related to the [https://github.com/multitheftauto/mtasa-resources mtasa-resources] project. Read more about it here: [[Default resources]]~~</p>~~		This page is related to the [https://github.com/multitheftauto/mtasa-resources mtasa-resources] project. Read more about it here: [[Default resources]]

			{{Note\|This article is currently '''Work In Progress'''}}

	<h2>Introduction</h2>		<h2>Introduction</h2>

Fernando187 at 23:51, 3 July 2024

2024-07-03T23:51:10Z

← Older revision		Revision as of 23:51, 3 July 2024
Line 1:		Line 1:
	<p><strong>Work in Progress</strong> - This page is related to the [https://github.com/multitheftauto/mtasa-resources mtasa-resources] project. We appreciate your interest in contributing to the development and improvement of the <strong>Default Lua resources that come with the Multi Theft Auto (MTA) multiplayer mod</strong>. To ensure high-quality code and a smooth collaboration process, please adhere to the following <strong>coding guidelines and contributing rules</strong>.</p>		<p><strong>Work in Progress</strong> - This page is related to the [https://github.com/multitheftauto/mtasa-resources mtasa-resources] project. Read more about it here: [[Default resources]]</p>

			<h2>Introduction</h2>
			<p>We appreciate your interest in contributing to the development and improvement of the <strong>Default Lua resources that come with the Multi Theft Auto (MTA) multiplayer mod</strong>. To ensure high-quality code and a smooth collaboration process, please adhere to the following <strong>coding guidelines and contributing rules</strong>.</p>

	<h2>Coding Guidelines</h2>		<h2>Coding Guidelines</h2>

Fernando187 at 13:51, 2 July 2024

2024-07-02T13:51:40Z

← Older revision		Revision as of 13:51, 2 July 2024
Line 1:		Line 1:
	<p><strong>Work in Progress</strong> - ~~Welcome~~ to the [https://github.com/multitheftauto/mtasa-resources mtasa-resources] project! We appreciate your interest in contributing to the development and improvement of the <strong>Default Lua resources that come with the Multi Theft Auto (MTA) multiplayer mod</strong>. To ensure high-quality code and a smooth collaboration process, please adhere to the following <strong>coding guidelines and contributing rules</strong>.</p>		<p><strong>Work in Progress</strong> - This page is related to the [https://github.com/multitheftauto/mtasa-resources mtasa-resources] project. We appreciate your interest in contributing to the development and improvement of the <strong>Default Lua resources that come with the Multi Theft Auto (MTA) multiplayer mod</strong>. To ensure high-quality code and a smooth collaboration process, please adhere to the following <strong>coding guidelines and contributing rules</strong>.</p>

	<h2>Coding Guidelines</h2>		<h2>Coding Guidelines</h2>

Fernando187 at 10:38, 2 July 2024

2024-07-02T10:38:21Z

← Older revision		Revision as of 10:38, 2 July 2024
Line 13:		Line 13:
	<h3>Indentation and Formatting</h3>		<h3>Indentation and Formatting</h3>
	<p>Ensure your code editor (e.g. [https://code.visualstudio.com/ Visual Studio Code]) applies the rules established by the project's <b>.editorconfig</b> file.</p>		<p>Ensure your code editor (e.g. [https://code.visualstudio.com/ Visual Studio Code]) applies the rules established by the project's <b>.editorconfig</b> file.</p>

	~~<h3>Error Handling</h3>~~
	~~TODO~~

	<h3>Consistent Naming Conventions</h3>		<h3>Consistent Naming Conventions</h3>
Line 25:		Line 22:
	<h3>Script Security</h3>		<h3>Script Security</h3>
	<p>Follow the [[Script security]] principles established for MTA:SA scripts to ensure the safety and integrity of your code.</p>		<p>Follow the [[Script security]] principles established for MTA:SA scripts to ensure the safety and integrity of your code.</p>

			<h3>Error Handling</h3>
			TODO

	<h3>Performance Considerations</h3>		<h3>Performance Considerations</h3>

Fernando187 at 10:38, 2 July 2024

2024-07-02T10:38:01Z

@@ Line 13: / Line 13: @@
 <h3>Indentation and Formatting</h3>
 <p>Ensure your code editor (e.g. [https://code.visualstudio.com/ Visual Studio Code]) applies the rules established by the project's <b>.editorconfig</b> file.</p>
 <h3>Script Security</h3>
@@ Line 49: / Line 58: @@
 end
 </syntaxhighlight>
 <h2>Contributing Rules</h2>

Fernando187 at 10:37, 2 July 2024

2024-07-02T10:37:25Z

← Older revision		Revision as of 10:37, 2 July 2024
Line 49:		Line 49:
	end		end
	</syntaxhighlight>		</syntaxhighlight>

			<h3>Error Handling</h3>
			TODO

			<h3>Consistent Naming Conventions</h3>
			TODO

			<h3>Use of Constants</h3>
			TODO

	<h2>Contributing Rules</h2>		<h2>Contributing Rules</h2>

Fernando187 at 10:29, 2 July 2024

2024-07-02T10:29:46Z

← Older revision		Revision as of 10:29, 2 July 2024
Line 62:		Line 62:
	<li>Fork the repository and create a new branch for your feature or bug fix.</li>		<li>Fork the repository and create a new branch for your feature or bug fix.</li>
	<li>Ensure your code follows the coding guidelines outlined above.</li>		<li>Ensure your code follows the coding guidelines outlined above.</li>
			<li>Commit small, atomic changes with clear commit messages.</li>
	<li>Include a clear and descriptive title and description of your changes.</li>		<li>Include a clear and descriptive title and description of your changes.</li>
	<li>Reference any related issues in your pull request description.</li>		<li>Reference any related issues in your pull request description.</li>

Fernando187: small improvements

2024-07-02T10:26:48Z

small improvements

← Older revision		Revision as of 10:26, 2 July 2024
Line 1:		Line 1:
	<p><strong>Work in ~~progress~~</strong> - Welcome to the [https://github.com/multitheftauto/mtasa-resources mtasa-resources] project! We appreciate your interest in contributing to the development and improvement of the <strong>Default Lua resources that come with the Multi Theft Auto multiplayer mod</strong>. To ensure high-quality code and a smooth collaboration process, please adhere to the following <strong>coding guidelines and contributing rules</strong>.</p>		<p><strong>Work in Progress</strong> - Welcome to the [https://github.com/multitheftauto/mtasa-resources mtasa-resources] project! We appreciate your interest in contributing to the development and improvement of the <strong>Default Lua resources that come with the Multi Theft Auto (MTA) multiplayer mod</strong>. To ensure high-quality code and a smooth collaboration process, please adhere to the following <strong>coding guidelines and contributing rules</strong>.</p>

	<h2>Coding Guidelines</h2>		<h2>Coding Guidelines</h2>
Line 7:		Line 7:
	<li>Follow the [https://en.wikipedia.org/wiki/Don%27t_repeat_yourself DRY (Don't Repeat Yourself)] principle.</li>		<li>Follow the [https://en.wikipedia.org/wiki/Don%27t_repeat_yourself DRY (Don't Repeat Yourself)] principle.</li>
	<li>Adhere to the [https://en.wikipedia.org/wiki/KISS_principle KISS (Keep It Simple, Stupid)] principle.</li>		<li>Adhere to the [https://en.wikipedia.org/wiki/KISS_principle KISS (Keep It Simple, Stupid)] principle.</li>
	<li>Use meaningful variable and function names that convey ~~the~~ purpose.</li>		<li>Use meaningful variable and function names that convey their purpose.</li>
	<li>Comment your code where necessary to explain the logic.</li>		<li>Comment your code where necessary to explain the logic.</li>
	</ul>		</ul>

	<h3>Indentation and Formatting</h3>		<h3>Indentation and Formatting</h3>
	<p>~~Make sure~~ your code editor (e.g. [https://code.visualstudio.com/ Visual Studio Code]) applies the rules established by the project's <b>.editorconfig</b> file.</p>		<p>Ensure your code editor (e.g. [https://code.visualstudio.com/ Visual Studio Code]) applies the rules established by the project's <b>.editorconfig</b> file.</p>

	<h3>Script Security</h3>		<h3>Script Security</h3>
	<p>Follow the [[Script security]] principles established for MTA:SA scripts.</p>		<p>Follow the [[Script security]] principles established for MTA:SA scripts to ensure the safety and integrity of your code.</p>

	<h3>Performance Considerations</h3>		<h3>Performance Considerations</h3>
	<ul>		<ul>
	<li>Avoid unnecessary computations within loops.</li>		<li>Avoid unnecessary computations within loops.</li>
	<li>Cache results of expensive operations ~~when~~ possible.</li>		<li>Cache results of expensive operations whenever possible.</li>
	<li>Use local variables to improve performance.</li>		<li>Use local variables to improve performance.</li>
	</ul>		</ul>
Line 60:		Line 60:
	<h3>Submitting Pull Requests</h3>		<h3>Submitting Pull Requests</h3>
	<ul>		<ul>
	<li>Fork the repository and create a new branch for your feature or ~~bugfix~~.</li>		<li>Fork the repository and create a new branch for your feature or bug fix.</li>
	<li>Ensure your code follows the coding guidelines outlined above.</li>		<li>Ensure your code follows the coding guidelines outlined above.</li>
	<li>Include a clear and descriptive title and description of your changes.</li>		<li>Include a clear and descriptive title and description of your changes.</li>
Line 74:		Line 74:
	<li>Once approved, your pull request will be merged into the main branch.</li>		<li>Once approved, your pull request will be merged into the main branch.</li>
	</ul>		</ul>


	[[Category: Development]]		[[Category: Development]]