Development - How to contribute code

Created: 2022-02-26 10:56:04 || Updated: 2022-04-13 17:09:44

If you are able to make a contribution that would make ITFlow better for everyone, please fork the repo and create a pull request.

For large changes/new features, please discuss the issue with other contributors first.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature)
  3. Commit your Changes (git commit -m 'Add some')
  4. Push to the Branch (git push origin feature)
  5. Open a Pull Request

ITFlow, along with all contributions, is licensed under the GNU GPL license.

---

I'm not a developer but want to try and contribute code

As mentioned on the about page, the main contributors 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 page. This will give you an idea of how we name variables and what files do what.

If you need some help with using Git/GitHub, this article is a great resource.

Once you've got a working install (see installation), switch to a new branch (git checkout -b mybranch).

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.
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.
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.
You'll be prompted to raise a pull request where we can discuss your changes and eventually merge them into ITFlow!