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
contribute [2025/06/07 16:03] – [Policies & Guidelines] c/e wrongechocontribute [2026/02/19 09:10] (current) – pause new PRs wrongecho
Line 5: Line 5:
 You can contribute to ITFlow in a few ways: You can contribute to ITFlow in a few ways:
  
-  * Contribute code 
   * Update documentation by selecting the pencil icon on the right-side of a page   * Update documentation by selecting the pencil icon on the right-side of a page
-  * Report bugs +  * Report bugs (on the Forum) 
-  * Suggest feature enhancements+  * Suggest feature enhancements (on the Forum)
   * Star the project on GitHub   * Star the project on GitHub
   * Tell others of your success using ITFlow (please don't spam)   * Tell others of your success using ITFlow (please don't spam)
  
 +===== Contributing Code =====
 +
 +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.
  
 ===== Policies & Guidelines ===== ===== Policies & Guidelines =====
Line 23: Line 25:
   * [[doc_standards|Documentation standards]]   * [[doc_standards|Documentation standards]]
   * [[ai_llm_policy|Use of AI / LLM]]   * [[ai_llm_policy|Use of AI / LLM]]
- 
-===== Contribute Code ===== 
- 
-To contribute code to ITFlow, you will need to fork the repository and create a pull request. 
- 
-Before doing so, please ensure to discuss the issue/idea with other contributors on the Forum first - this saves everyone time and ensures your contribution is aligned with our goals. 
- 
-The code for ITFlow is split into two branches: 
-  - **master** - The main codebase for all installs, updated ~monthly (demo: demo.itflow.org) 
-  - **develop** - The active development branch, all PRs should be merged here (demo: develop.dev.itflow.org) 
- 
-==== Steps to raise a pull request (PR) ==== 
-  - Fork the Project on GitHub 
-  - Clone the develop branch: (''git clone //-//-branch develop https://github.com/itflow-org/itflow.git'') and follow the setup guide 
-  - Set your ''$repo_branch'' in ''config.php'' to 'develop' 
-  - Create your branch (''git checkout -b my-branch'') 
-  - Commit your Changes (''git add something.txt && git commit -m 'Add some''') 
-  - Push to your branch (''git push origin my-branch'') 
-  - Open a Pull Request, ensuring to adjust the base from master to develop 
-  - {{:pr_-_select-mh.png?direct&550|}} 
  
  
Line 51: Line 33:
   - Ensure testing has been completed as much as possible   - Ensure testing has been completed as much as possible
   - Update the changelog   - Update the changelog
-  - In develop, increment version.php in the YY.M.V format (e.g. 25.1 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)+  - 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