How to contribute new features - Revision history

P teichmann at 12:37, 20 May 2026

2026-05-20T12:37:33Z

← Older revision		Revision as of 14:37, 20 May 2026
Line 14:		Line 14:
	# We will then assign the ticket to one of our developers and discuss your approach. It's important to tell us about your plans '''before''' you start coding because otherwise you might take the wrong way when implementing new features so we might have to say "Sorry, we can't take that one (because of security problems or what so ever)".		# We will then assign the ticket to one of our developers and discuss your approach. It's important to tell us about your plans '''before''' you start coding because otherwise you might take the wrong way when implementing new features so we might have to say "Sorry, we can't take that one (because of security problems or what so ever)".
	# Once implementation details were discussed just start coding and create a Github pull request afterwards and ask for a developer to review your coding.		# Once implementation details were discussed just start coding and create a Github pull request afterwards and ask for a developer to review your coding.
	# Make sure to write unit or functional tests that tests your new functionality. If you don't know how to set it up, please read this [https://manual.limesurvey.org/Regression_and_unit_tests manual page] or ask in the ~~#limesurvey IRC channel~~ for help.		# Make sure to write unit or functional tests that tests your new functionality. If you don't know how to set it up, please read this [https://manual.limesurvey.org/Regression_and_unit_tests manual page] or ask in the [https://discord.com/invite/DEjguXn LimeSurvey discord] for help.
	# There might be some further discussions about implementation details but once this was solved, your feature will be available in the next new version.		# There might be some further discussions about implementation details but once this was solved, your feature will be available in the next new version.

C schmitz: /* Static analysis */

2025-11-19T12:13:41Z

Static analysis

← Older revision		Revision as of 14:13, 19 November 2025
Line 93:		Line 93:
	=Static analysis=		=Static analysis=

	~~{{NewIn\|v=4.3}}~~		Run some analysis toosl on your code to make sure you have the correct docblocks, no unused variables, and apply [https://www.php-fig.org/psr/psr-12/ PSR-12].

	~~It's a good idea to run~~ some analysis on your code to make sure you have the correct docblocks, no unused ~~variable~~, and apply [https://www.php-fig.org/psr/psr-12/ PSR-12].

	Run		Run

C schmitz: /* Static analysis */

2025-11-19T12:13:09Z

Static analysis

← Older revision		Revision as of 14:13, 19 November 2025
Line 95:		Line 95:
	{{NewIn\|v=4.3}}		{{NewIn\|v=4.3}}

	It's a good idea to run some analysis on your code to make sure you have the correct docblocks, no unused variable, and apply [https://www.php-fig.org/psr/psr-2/ PSR-2].		It's a good idea to run some analysis on your code to make sure you have the correct docblocks, no unused variable, and apply [https://www.php-fig.org/psr/psr-12/ PSR-12].

	Run		Run

C schmitz: /* How to create a pull request? */

2025-11-19T12:12:38Z

How to create a pull request?

← Older revision		Revision as of 14:12, 19 November 2025
Line 42:		Line 42:
	** Bug fixes: '''master'''		** Bug fixes: '''master'''

	* Branch the source branch for your feature/bug fix to a separate branch		* Branch the source branch for your feature/bug fix to a separate branch (see branch naming below)
	* Develop your bug fix/feature on that separate branch.		* Develop your bug fix/feature on that separate branch.
	* Push your branch to the repository (internal developer) or push it to your personal fork (external)		* Push your branch to the repository (internal developer) or push it to your personal fork (external)

C schmitz: /* How to create a pull request? */

2025-11-19T12:11:58Z

How to create a pull request?

← Older revision		Revision as of 14:11, 19 November 2025
Line 43:		Line 43:

	* Branch the source branch for your feature/bug fix to a separate branch		* Branch the source branch for your feature/bug fix to a separate branch
			* Develop your bug fix/feature on that separate branch.
	* Push your branch to the repository (internal developer) or push it to your personal fork (external)		* Push your branch to the repository (internal developer) or push it to your personal fork (external)
	* Visit https://github.com/LimeSurvey/LimeSurvey and navigate to '''Pull requests''' tab.		* Visit https://github.com/LimeSurvey/LimeSurvey and navigate to '''Pull requests''' tab.

C schmitz: /* How to create a pull request? */

2025-11-19T12:07:51Z

How to create a pull request?

← Older revision		Revision as of 14:07, 19 November 2025
Line 39:		Line 39:
	* First figure out the source branch you need:		* First figure out the source branch you need:
	** New backward-compatible features: '''develop-minor'''		** New backward-compatible features: '''develop-minor'''
	** New backward-incompatible ~~feature~~: '''develop-major'''		** New backward-incompatible features: '''develop-major'''
	** Bug fixes: '''master'''		** Bug fixes: '''master'''

C schmitz: /* How to create a pull request? */

2025-11-19T12:07:16Z

How to create a pull request?

← Older revision		Revision as of 14:07, 19 November 2025
Line 37:		Line 37:

	=How to create a pull request?=		=How to create a pull request?=
	* First figure out ~~our~~ source branch:		* First figure out the source branch you need:
	** New backward-compatible features: '''develop-minor'''		** New backward-compatible features: '''develop-minor'''
	** New backward-incompatible feature: '''develop-major'''		** New backward-incompatible feature: '''develop-major'''

C schmitz: /* How to create a pull request? */

2025-11-19T12:06:58Z

How to create a pull request?

← Older revision		Revision as of 14:06, 19 November 2025
Line 38:		Line 38:
	=How to create a pull request?=		=How to create a pull request?=
	* First figure out our source branch:		* First figure out our source branch:
	** New backward-compatible features: 'develop-minor'		** New backward-compatible features: '''develop-minor'''
	** New backward-incompatible feature: 'develop-major'		** New backward-incompatible feature: '''develop-major'''
	** Bug fixes: 'master'		** Bug fixes: '''master'''

	* Branch the source branch for your feature or bug fix to a separate branch		* Branch the source branch for your feature/bug fix to a separate branch
	* Push your branch to the repository (internal developer) or push it to your personal fork (external)		* Push your branch to the repository (internal developer) or push it to your personal fork (external)
	* Visit https://github.com/LimeSurvey/LimeSurvey and navigate to '''Pull requests''' tab.		* Visit https://github.com/LimeSurvey/LimeSurvey and navigate to '''Pull requests''' tab.

C schmitz: /* How to create a pull request? */

2025-11-19T12:06:06Z

How to create a pull request?

← Older revision		Revision as of 14:06, 19 November 2025
Line 37:		Line 37:

	=How to create a pull request?=		=How to create a pull request?=
	* ~~Develop~~ your feature or bug fix in a separate branch		* First figure out our source branch:
			** New backward-compatible features: 'develop-minor'
			** New backward-incompatible feature: 'develop-major'
			** Bug fixes: 'master'

			* Branch the source branch for your feature or bug fix to a separate branch
	* Push your branch to the repository (internal developer) or push it to your personal fork (external)		* Push your branch to the repository (internal developer) or push it to your personal fork (external)
	* Visit https://github.com/LimeSurvey/LimeSurvey and navigate to '''Pull requests''' tab.		* Visit https://github.com/LimeSurvey/LimeSurvey and navigate to '''Pull requests''' tab.
	* Click on the '''Create pull request''' button		* Click on the '''Create pull request''' button
	* Select the ~~base~~ branch ~~(new features should go to 'develop'~~, ~~bug fixes should go to 'master') and add your branch with your bug fix/feature.~~		* Select the source branch you used,
	* ~~The header~~ of the pull request ~~should be~~ the same text as required in our [[Standard for Git commit messages]]. Please also enter a meaningful description of what you fixed.		* For the title of the pull request use the same text as required in our [[Standard for Git commit messages]]. Please also enter a meaningful description of what you fixed.
			* Confirm to create the PR and you are done.

	=How to merge a pull request?=		=How to merge a pull request?=

C schmitz: /* Internal contribution process */

2025-11-19T12:00:17Z

Internal contribution process

← Older revision		Revision as of 14:00, 19 November 2025
Line 26:		Line 26:

	* New features are always on feature branches		* New features are always on feature branches
	* New features are never merged into develop branch before QA		* New features are never merged into develop-minor or develop-major branch before QA
	* Bug fixes are in bug branches and should always have a '''pull request''' on GitHub for code review and comments		* Bug fixes are in bug branches and should always have a '''pull request''' on GitHub for code review and comments
	* Pull requests with a single author are squashed and merged		* Pull requests with a single author are squashed and merged