Page History

...

Following the last statement will close the GitHub pull request. It is important to close via the commit message, because we cannot only the author can close pull requests request via the GitHub Web UI.

Example Commit message (80 columns)

...

[REEF-33] Allow Tasks to initiate an Evaluator Heartbeat
 
  This adds the class HeartBeatTriggerManager which can be used by a Task to
  initiate an Evaluator Heartbeat. It is used by injecting it into the Task.
 
JIRA:
  [REEF-33] https://issues.apache.org/jira/browse/REEF-33
 
Pull Request:
  Closes #24
 
Author:
  AuthorName AuthorEmail

Resolving issue vs Closing issue

The last step of merging a pull request is resolving the associated issue. Committer should resolve it, provide the current release number in "Fix version" field and provide a link to the pull request in the comment.

Issue should be closed only if no productive steps were taken for it, i.e. it is "won't fix" or "duplicate" or "contained by". If steps were taken but they don't have pull request associated with them, the issue should be resolved by the person who took the steps.

Method A

PowerShell setup instructions contain functions which wrap the following actions and make committer's life easier.

A-1. Create a branch on your local git repository

...

1. Make sure the code compiles and all tests pass.
1. If the pull request changes any POM.xml file: Please either clean your local maven repository before testing OR wait for the build servers to confirm that the project builds. This is to avoid situations in which an artifact was renamed or removed but is still in your local maven repository.

2. Test java code 

   At REEF root folder

   Code Block
   title Run Java Tests
   mvn clean install

3. Test .Net code

   To run tests in command line, go to folder $REEFSourcePath\lang\cs\ and build the projects with the command line:

   Code Block
   title Build .Net source code in debug mode
   msbuild

   Where $REEFSourcePath is REEF source code root folder.

   Then go to folder $REEFSourcePath\lang\cs\bin\x64\debug\Org.Apache.REEF.Tests, run command:

   Code Block
   title Run .Net Tests with command line
   vstest.console.exe Org.Apache.REEF.Tests.dll /Platform:x64

   Alternatively, open $REEFSourcePath\lang\cs\OrgApacheREEFsln in VS, rebuild entire solution, then run all tests in Test explore. Note: tests executed from VS are a superset of tests executed by vstest.

2. If the code touches code that you suspect might break on YARN or Mesos, please test on those environments. If you don't have access to a test environment, ask on the mailing list for help.

3. Make sure the code adheres to our coding guidelines.

4. Make sure that the additions don't create errors in a Apache RAT check via mvn apache-rat:check

...