Recent changes to Contribution

Contribution modified by Ingo

Ingo — Mon, 08 Oct 2018 05:14:28 -0000

--- v3
+++ v4
@@ -40,7 +40,7 @@

 Note, in every commit, you have to reference your ticket. For a better transparency there should be no commit without a ticket number.

-# Submit changes for project page
+## Submit changes for project page
 You can't expect to get write access to all project pages. If you found bugs, typos, etc. on the pages, please create a ticket for that, describing the issue.

 If you want to rework a bit more of a page, you should get the code by clicking on "Show page source" in the footer. Make your changes and attach it to the ticket.

Contribution modified by Ingo

Ingo — Mon, 08 Oct 2018 05:13:51 -0000

--- v2
+++ v3
@@ -40,6 +40,13 @@

 Note, in every commit, you have to reference your ticket. For a better transparency there should be no commit without a ticket number.

+# Submit changes for project page
+You can't expect to get write access to all project pages. If you found bugs, typos, etc. on the pages, please create a ticket for that, describing the issue.
+
+If you want to rework a bit more of a page, you should get the code by clicking on "Show page source" in the footer. Make your changes and attach it to the ticket.
+
+Then an admin is able to integrate it after a review.
+
 # Summary of rules

 * Either commit directly on trunk/Master or create your own branch/Fork

Contribution modified by codesys.com

codesys.com — Thu, 04 Jan 2018 15:23:49 -0000

--- v1
+++ v2
@@ -23,7 +23,7 @@

 For a more detailed description about Source Code or Ticket Management visit the following pages:

-* [SourceCode]
+* [SCM Repositories]
 * [Tickets]

 Otherwise you should follow the following rules:

Contribution modified by codesys.com

codesys.com — Thu, 04 Jan 2018 15:22:55 -0000

Best practices
- Communication
- Commit Code
Summary of rules

General
HowTos

Everyone who already tried to contribute to an open source project knows, that this can be a tricky task. Every project manages its code slightly different, defines different rights to commit, have different ways to communicate.

On one project you have to apply for a mailing list and post patches
On another project you commit to your own branch or fork
Some may have strong coding guidelines
Others are test driven developed and you need to pass a CI server

Best practices

As the scope of the projects on CODESYS Forge is very similar, we are defining some best practices here. But every project is still free to deviate from those rules.

Communication

If you need to contact one of the developers, just visit his profile and click on "send message". He will then receive an E-Mail.

Some projects might have a Forum. If so, this should be the first place to ask questions

Commit Code

For a more detailed description about Source Code or Ticket Management visit the following pages:

[SourceCode]
[Tickets]

Otherwise you should follow the following rules:

Create a Ticket if it doesn't exist, yet
Assign the ticket to you
Maybe add some comments to the ticket about how you plan to solve the issue

Now, it depends on your confidence:

If the change is small and you have a high confidence, you can commit your change directly to "trunk" (SVN) or "Master" (Git).
If the modification is bigger or you are not sure about your solution, you should commit it on a "branch" (SVN) or " Fork" (Git).
If you commited directly to trunk/Master, you can now close the ticket. If you used a branch/Fork, set the status to "pending", add a comment to it and wait for a maintainer to integrate it.

Note, in every commit, you have to reference your ticket. For a better transparency there should be no commit without a ticket number.

Summary of rules

Either commit directly on trunk/Master or create your own branch/Fork
Name your branches or Forks after the corresponding ticket number. E.g.: "branches/ticket#26"
Don't close a ticket, which isn't merged, yet
Never commit w/o a ticket number
Also for releases, you should create a ticket, to trace the work involved in the release process.