You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: Contributing.md
+29-12Lines changed: 29 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,25 +1,35 @@
1
1
# Contributing to DGH IDE Auto Save
2
2
3
-
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.
3
+
Please try and follows the things that are layed out below as it will make it easier to accept a pull
4
+
request however not following the below does not necessarily exclude a pull request from being accepted.
4
5
5
6
## Git Flow
6
7
7
-
For [DGH IDE Auto Save](https://www.davidghoyle.co.uk/WordPress/?page_id=918) I use Git as the version control but I also use [Git Flow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow) 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.
8
+
For [DGH IDE Auto Save](https://github.com/DGH2112/Auto-Save) I use Git as the version control but I also
9
+
use [Git Flow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow) for the
10
+
development cycles. The main development is undertaken in the **Development** branch with stable releases
11
+
being in the **master**. All pull requests should be made from the **Development** branch, prefereably
12
+
using **Feature** branches or **BugFix** branches. I've defined prefixes for these already in the
13
+
`.gitconfig` file. You should submit onyl one change per pull request at a time to make it easiler to
14
+
review and accept the pull request.
8
15
9
-
Tools wise, I generally use [SourceTree](https://www.sourcetreeapp.com/) 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.
16
+
Tools wise, I generally use [Fork](https://fork.dev/) but that does not support Git Flow's **BugFix**
17
+
functionality so I drop down to the command prompt to create **BugFix** branches as SourceTree can
18
+
_Finish_ any type of open branch in Git Flow.
10
19
11
20
## Creating Pull Requests
12
21
13
-
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](https://github.com/VSoftTechnologies/DUnitX) project:
22
+
Having not done this before as I've always been the sole contributor to my repositories so I borrowed the
23
+
essense of the following from the [DUnitX](https://github.com/VSoftTechnologies/DUnitX) project:
14
24
15
25
1. Create a [GitHub Account](https://github.com/join);
16
-
2. Fork the [DGH IDE Auto Save](https://www.davidghoyle.co.uk/WordPress/?page_id=918)
26
+
2. Fork the [DGH IDE Auto Save](https://github.com/DGH2112/Auto-Save)
17
27
Repository and setup your local repository as follows:
18
28
*[Fork the repository](https://help.github.com/articles/fork-a-repo);
19
29
* Clone your Fork to your local machine;
20
30
* Configure upstream remote to the **Development**
21
-
[DGH IDE Auto Save](https://www.davidghoyle.co.uk/WordPress/?page_id=918)
* Create a new **Feature** or **BugFix** branch for your change;
25
35
* Make your change in your new branch;
@@ -29,23 +39,30 @@ Having not done this before as I've always been the sole contributor to my repos
29
39
* Submit a [Pull Request](https://help.github.com/articles/using-pull-requests);
30
40
* Note: local and remote branches can be deleted after pull request has been accepted.
31
41
32
-
**Note:** Getting changes from others requires [Syncing your Local repository](https://help.github.com/articles/syncing-a-fork) with the **Development**[DGH IDE Auto Save](https://www.davidghoyle.co.uk/WordPress/?page_id=918) repository. This can happen at any time.
42
+
**Note:** Getting changes from others requires
43
+
[Syncing your Local repository](https://help.github.com/articles/syncing-a-fork) with the **Development**
44
+
[DGH IDE Auto Save](https://github.com/DGH2112/Auto-Save) repository. This can happen at any time.
33
45
34
46
## Dependencies
35
47
36
-
[DGH IDE Auto Save](https://www.davidghoyle.co.uk/WordPress/?page_id=918) has no dependencies.
48
+
[DGH IDE Auto Save](https://github.com/DGH2112/Auto-Save) has no dependencies.
37
49
38
50
## Project Configuration
39
51
40
-
The [DGH IDE Auto Save](https://www.davidghoyle.co.uk/WordPress/?page_id=918) Open Tools API project uses a single 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.
52
+
The [DGH IDE Auto Save](https://github.com/DGH2112/Auto-Save) Open Tools API project uses a single
53
+
projects file (`.DPR`) to compile to mutliple versions of RAD Studio by use 2 include files: one for
54
+
compiler specific coding and the second to implement the correct suffix for the DLL.
41
55
42
56
The current code base only supports RAD Studio XE2 and above.
43
57
44
58
## Rationale
45
59
46
-
The following is a brief description of the rationale behind [DGH IDE Auto Save](https://www.davidghoyle.co.uk/WordPress/?page_id=918). I will hopefully write more later.
60
+
The following is a brief description of the rationale behind
61
+
[DGH IDE Auto Save](https://github.com/DGH2112/Auto-Save). I will hopefully write more later.
47
62
48
-
This plug-in uses a timer to periodically iterate the code editor buffers in the RAD Studio IDE and see if they have been modified and need to be saved. It can also be configured to save before or after a compilation.
63
+
This plug-in uses a timer to periodically iterate the code editor buffers in the RAD Studio IDE and see
64
+
if they have been modified and need to be saved. It can also be configured to save before or after a
0 commit comments