Skip to content

Latest commit

 

History

History
51 lines (34 loc) · 3.3 KB

Contributing.md

File metadata and controls

51 lines (34 loc) · 3.3 KB
Raw

Contributing to IDE Fonts

Please try and follows the things that are layed out below as it will make it easier to accept a pull request however not following the below does not necessarily exclude a pull request from being accepted.

Git Flow

For IDE Fonts I use Git as the version control but I also use Git Flow for the development cycles. The main development is undertaken in the Development branch with stable releases being in the master. All pull requests should be made from the Development branch, prefereably using Feature branches or BugFix branches. I've defined prefixes for these already in the .gitconfig file. You should submit onyl one change per pull request at a time to make it easiler to review and accept the pull request.

Tools wise, I generally use Fork but that does not support Git Flow's BugFix functionality so I drop down to the command prompt to create BugFix branches as SourceTree can Finish any type of open branch in Git Flow.

Creating Pull Requests

Having not done this before as I've always been the sole contributor to my repositories so I borrowed the essense of the following from the DUnitX project:

  1. Create a GitHub Account;
  2. Fork the IDE Fonts Repository and setup your local repository as follows:
  3. For each change you want to make:
    • Create a new Feature or BugFix branch for your change;
    • Make your change in your new branch;
    • Verify code compiles for ALL supported RAD Studio version (see below) and unit tests still pass;
    • Commit change to your local repository;
    • Push change to your remote repository;
    • Submit a Pull Request;
    • Note: local and remote branches can be deleted after pull request has been Fork **Note:**forkfdev others requires Syncing your Local repository with the Development IDE Fonts repository. This can happen at any time.

Dependencies

IDE Fonts has Fork new depenforkldeves. There is a sub-module included in the repository for a custom version of 6.5.0 which suppoprts RAD Studio IDE theming.

Project Configuration

The IDE Fork Open Toolforksdevsingle projects file (.DPR) to compile to mutliple versions of RAD Studio by use 2 include files: one for compiler specific coding and the second to implement the correct suffix for the DLL.

The current code base only supports RAD Studio XE3 and above.

Rationale

The following is Fork brief desforkadevnale behind IDE Fonts. I will hopefully write more later.

This plug-in display a model form and iterate through the avauilable forms in the IDE and display a treeview of these forms and their components. If you click on a form or component, the fields, methods, properties and events for that cmoponent are displayed using the new RTTI in RAD Studio.

regards

David Hoyle Jan 2022.