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 [2023/09/28 06:55] – Add other ways to contribute besides code 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 do!
  
-If you are able to make a contribution that would make ITFlow better for everyone, please fork the repository and create a pull request.+You can contribute to ITFlow in a few ways:
  
-For large changes/new features, please discuss the issue with other contributors first.+  * 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)
  
-  - Fork the Project +===== Contributing Code =====
-  - Create your Feature Branch (''git checkout -b feature'') +
-  - Commit your Changes (''git commit -m 'Add some''') +
-  - Push to the Branch (''git push origin feature'') +
-  - Open a Pull Request+
  
-ITFlow, along with all contributions, is [[https://github.com/itflow-org/itflow/blob/master/LICENSE|licensed under the GNU GPL]].+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 =====
  
-===== I'm not a developer but want to try and contribute code =====+Before contributing to ITFlow you should be aware of these documents:
  
 +  * [[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]]
  
-The core maintainers of ITFlow are more Sysadmins than developers. If you've got an idea of something you'd like to change in ITFlow, give it a try! This could be anything and doesn't have to be huge to be helpful to the project - fixing typos, adjusting icons, etc. 
  
-First, review the [[code_standards|code standards]] page. This will give you an idea of how we name variables and what files do what.+=====Maintainer Steps for monthly releases=====
  
-If you need some help with using Git/GitHub, [[https://www.dataschool.io/how-to-contribute-on-github/|this article]] is a great resource.+Around once a month, we will merge develop into master for a new release. The steps are:
  
-Once you've got a working [[installation|installation]], switch to a new branch (''git checkout -b mybranch''). +  - Ensure testing has been completed as much as possible 
- +  - Update the changelog 
-Locate the page that holds the functionality you'd like to amend and start making changes. It's usually helpful to break down your desired goal into small chunks you can incrementally add. +  - 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 
-//If you're doing lots of work with forms (generally submitting to post.php), you might want to look into something like Burp Suite to speed things up.// +  - Raise a PR to merge develop into master 
- +  - Test a final time on PR Review & ensure no other issues (Sonar, Linting, etc) 
-Once you've got your changes working, add & commit your files (''git add myfile.php && git commit -m "My change"''), and push them to your GitHub account (''git push origin mybranch''). +  - Approve the PR & Merge
- +
-You'll be prompted to raise a pull request where we can discuss your changes and eventually merge them into ITFlow! +
- +
----- +
- +
-====== Other ways to contribute ====== +
- +
-There are other ways to contribute to ITFlow: +
- +
-  * Help out with the documentation //(ask on the forum for a Docuwiki account)// +
-  * 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)//+