Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

We use git as our version control system. To streamline the process of giving proper credit to the contributors when committing patches, we encourage contributors to submit patches generated using "git format-patch" command. This has many benefits:

  • Committers can't will not forget to attribute give proper credit to the a contributor
  • The contributors Contributor's name and email address shows show up in the git log

Long story short, it makes both the contributors' and committers' lives easier, so please generate your patches using git format-patch.

We have next the following requirements to for patches:

  • patch can be applied to the HEAD of current ignite-sprint-xxx branch by "git am <patch-file>" without conflicts.
  • patch has to have all changes in one commit with comment like "ignite-xxx: Implemented."
  • patch-file has to have 'patch', 'txt' or 'diff' extension

Patch creation process

We suggest to prefer that you use the next following step-by-step schema then you developing somethinginstructions when developing with Ignite.

For example, if you are starting developing working on the feature IGNITE-9999, which the work should be fixed at done in ignite-sprint-999 branch.

## Get the repo
git clone -b ignite-sprint-999 https://github.com/apache/incubator-ignite.git
git checkout -b ignite-9999

...

Created patch-file should be attached to a JIRA ticket and the ticket status should be changed on Patch Available.

If you do all righteverything correctly, then all necessary TC test builds will be triggered automatically in 3 minutes period, and a comment with triggered builds build information (test package names and link on builds, TC build links) will be added to the JIRA.

...