meta data for this page
  •  

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
contribute [2024/12/30 14:30] – fix double dash not showing for --branch wrongechocontribute [2026/02/19 09:10] (current) – pause new PRs wrongecho
Line 1: Line 1:
-====== Contribute Code ======+====== Contributing to ITFlow ======
  
-If you are able to make a contribution that would make ITFlow better for everyone, please fork the repository and create a pull request.+If you are able to make a contribution that would make ITFlow better for everyone, please do!
  
-We have moved to using two main branches: +You can contribute to ITFlow in a few ways:
-  - **master** - The main codebase for all installs, updated monthly +
-  - **develop** - The active development branch, all PRs should be merged here+
  
-//For large changes/new features, please ensure to discuss the issue/idea with other contributors on the Forum first. This saves everyone time.//+  * Update documentation by selecting the pencil icon on the right-side of a page 
 +  * Report bugs (on the Forum) 
 +  * Suggest feature enhancements (on the Forum) 
 +  * Star the project on GitHub 
 +  * Tell others of your success using ITFlow (please don't spam)
  
-**Steps to raise a PR** +===== Contributing Code =====
-  - Fork the Project on GitHub +
-  - Clone the development branch: (''git clone //-//-branch develop https://github.com/itflow-org/itflow.git'') +
-  - Create your Feature Branch (''git checkout -b my-feature'') +
-  - Commit your Changes (''git add something.txt && git commit -m 'Add some''') +
-  - Push to the Branch (''git push origin my-feature'') +
-  - Open a Pull Request, adusting the base from master to develop +
-  - {{:pr_-_select-mh.png?direct&550|}}+
  
-**General Guidance** +We do not have the bandwidth to review and mentor new submissions so have temporarily paused accepting pull requests / code contributions. Historically we've received very few PRs, but the ones we do get often propose major changes and require a significant amount of time and attention. We don't want to waste anyone's time, so we've paused this for now.
-  * Review the [[code_standards|code standards]] and the [[https://github.com/itflow-org/itflow/blob/master/CODE_OF_CONDUCT.md|code of conduct]] +
-  * Discuss changes with the community first +
-  * The core maintainers of ITFlow are Sysadmins just like you! If you've got an idea of something you'd like to change in ITFlow, give it a try! +
-  * If you need some help with using Git/GitHub, [[https://www.dataschool.io/how-to-contribute-on-github/|this article]] is a great resource. +
-  * Don't test on production; run a separate ITFlow instance for development +
-  * Have some patience, this is a volunteer project+
  
-ITFlow, along with all contributions, is [[https://github.com/itflow-org/itflow/blob/master/LICENSE|licensed under the GNU GPL]]. By contributing you grant us a perpetual & irrevocable license to include your work in ITFlow - on behalf of the community, thank you.+===== Policies & Guidelines =====
  
-====== Other ways to contribute ======+Before contributing to ITFlow you should be aware of these documents:
  
-There are other ways to contribute to ITFlow:+  * [[https://github.com/itflow-org/itflow/blob/master/LICENSE|GNU GPL License]] 
 +  * [[https://github.com/itflow-org/itflow/blob/master/CODE_OF_CONDUCT.md|Code of conduct]] 
 +  * [[https://github.com/itflow-org/itflow/security|Security policy]] 
 +  * [[code_standards|Code Standards]] 
 +  * [[doc_standards|Documentation standards]] 
 +  * [[ai_llm_policy|Use of AI / LLM]]
  
-  * Help out with the documentation 
-  * Share your experience / methodologies / tactics using ITFlow on the forum to inspire others 
-  * Report bugs and raise feature requests 
-  * Tell others in the industry of your success using ITFlow to manage your clients //(but please don't spam)// 
  
-======Maintainer Steps for monthly releases======+=====Maintainer Steps for monthly releases=====
  
-Once a month, we will merge develop into master:+Around once a month, we will merge develop into master for a new release. The steps are:
  
   - Ensure testing has been completed as much as possible   - Ensure testing has been completed as much as possible
-  - In develop, increment version.php in the YY.M.V format (e.g. 25.1 for the first release in Jan 2025, 25.1.2 for the second release of Jan 2025, and 25.6 for the first release in June 2025)+  - Update the changelog 
 +  - In develop, increment version.php in the YY.MM.V format (e.g. 25.01 for the first release in Jan 2025, 25.1.1 for the second release of Jan 2025, and 25.6 for the first release in June 2025)
   - Look over the recent changes and write a short release summary   - Look over the recent changes and write a short release summary
   - Raise a PR to merge develop into master   - Raise a PR to merge develop into master
   - Test a final time on PR Review & ensure no other issues (Sonar, Linting, etc)   - Test a final time on PR Review & ensure no other issues (Sonar, Linting, etc)
   - Approve the PR & Merge   - Approve the PR & Merge