archive/phabricator
1
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity

Add html instructions for diff/patch, todo and design tasks.

Browse Source
This commit is contained in:
Brecht Van Lommel
2013-11-08 19:30:04 +01:00
parent 458bc7f921
commit 4ea26f22c4
10 changed files with 123 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
migration/import_projects.php
View File

@@ -49,3 +49,5 @@ create_project("Text Editor", "None", true, array(), "Text editor built into Ble
//create_project("Tools", "None", true, array(), ""); // Tools
create_project("Game Engine", "None", true, array(), "Blender game engine.");
create_project("Websites", "None", true, array(), "Project for Blender websites like blender.org, developer.blender.org or wiki.blender.org.");

2
migration/import_task.php
View File

@@ -104,7 +104,7 @@ for($id = intval($argv[1]); $id < intval($argv[2]); $id+=1) {
}
if($close_as_archived)
$archive_message = "This task was automatically closed as archived as part of migration, because it was determined to be no longer active.\n\nThe authoritative list of addons is now on the wiki, only individual bug reports are handled here now. See the #Addons project page for more information on the workflow.";
$archive_message = "This task was automatically closed as archived as part of migration, because it was determined to be no longer active.\n\nThe authoritative list of addons is on the wiki, we no longer have a report for each addon to track bugs and updates. Bugs can be reported individually and assigned to the addon developers. See the #Addons project page for more information on the workflow.";
$extra .= "**Project**: " . $mtask->project . "\n";
$extra .= "**Tracker**: " . $mtask->tracker . "\n";

6
migration/migration_steps.txt
View File

@@ -6,7 +6,10 @@ A) CONFIGURE PHABRICATOR
./bin/config set feed.public true
./bin/config set welcome.file rsrc/custom/static/welcome.html
./bin/config set report_guidelines.file rsrc/custom/static/report_guidelines.html
./bin/config set patch_guidelines.file "rsrc/custom/static/patch_guidelines.html",
./bin/config set patch_guidelines.file "rsrc/custom/static/patch_guidelines.html"
./bin/config set diff_guidelines.file "rsrc/custom/static/diff_guidelines.html"
./bin/config set design_guidelines.file "rsrc/custom/static/design_guidelines.html"
./bin/config set todo_guidelines.file "rsrc/custom/static/todo_guidelines.html"
./bin/config set metamta.domain developer.blender.org
./bin/config set metamta.default-address noreply@developer.blender.org
./bin/config set metamta.user-address-format real
@@ -34,7 +37,6 @@ set maniphest.custom-field-definitions
"Patch": "Patch",
"Design": "Design",
"To Do": "To Do",
"Feature Request": "Feature Request",
"OpenGL Error": "OpenGL Error"
}
}

12
src/applications/config/option/PhabricatorCoreConfigOptions.php
View File

@@ -195,6 +195,18 @@ final class PhabricatorCoreConfigOptions
->setLocked(true)
->setDescription(
pht('Custom HTML file to show when submitting new patch.')),
$this->newOption('diff_guidelines.file', 'string', null)
->setLocked(true)
->setDescription(
pht('Custom HTML file to show when submitting new diff.')),
$this->newOption('design_guidelines.file', 'string', null)
->setLocked(true)
->setDescription(
pht('Custom HTML file to show when submitting new Design.')),
$this->newOption('todo_guidelines.file', 'string', null)
->setLocked(true)
->setDescription(
pht('Custom HTML file to show when submitting new To Do.')),
$this->newOption('phabricator.cache-namespace', 'string', null)
->setLocked(true)
->setDescription(pht('Cache namespace.')),

4
src/applications/differential/controller/DifferentialDiffCreateController.php
View File

@@ -53,11 +53,11 @@ final class DifferentialDiffCreateController extends DifferentialController {
$cancel_uri = $this->getApplicationURI();
if (PhabricatorEnv::getEnvConfig('patch_guidelines.file') !== null) {
if (PhabricatorEnv::getEnvConfig('diff_guidelines.file') !== null) {
$webroot = dirname(phutil_get_library_root('phabricator')).'/webroot/';
$instructions = phutil_safe_html(
FileSystem::readFile($webroot .
PhabricatorEnv::getEnvConfig('patch_guidelines.file')));
PhabricatorEnv::getEnvConfig('diff_guidelines.file')));
} else {
$instructions = pht(
'The best way to create a Differential diff is by using %s, but you '.

33
src/applications/maniphest/controller/ManiphestTaskEditController.php
View File

@@ -468,6 +468,36 @@ final class ManiphestTaskEditController extends ManiphestController {
$cancel_uri = '/T'.$parent_task->getID();
$button_name = pht('Create Task');
$header_name = pht('Create New Subtask');
} else if ($request->getStr('type') == 'Patch') {
$button_name = pht('Submit Patch');
$header_name = pht('Submit a Patch');
if (PhabricatorEnv::getEnvConfig('patch_guidelines.file') !== null) {
$webroot = dirname(phutil_get_library_root('phabricator')).'/webroot/';
$instructions = phutil_safe_html(
FileSystem::readFile($webroot .
PhabricatorEnv::getEnvConfig('patch_guidelines.file')));
}
} else if ($request->getStr('type') == 'Design') {
$button_name = pht('Create Design Task');
$header_name = pht('Create a Design Task');
if (PhabricatorEnv::getEnvConfig('design_guidelines.file') !== null) {
$webroot = dirname(phutil_get_library_root('phabricator')).'/webroot/';
$instructions = phutil_safe_html(
FileSystem::readFile($webroot .
PhabricatorEnv::getEnvConfig('design_guidelines.file')));
}
} else if ($request->getStr('type') == 'To Do') {
$button_name = pht('Create To Do');
$header_name = pht('Create a To Do');
if (PhabricatorEnv::getEnvConfig('todo_guidelines.file') !== null) {
$webroot = dirname(phutil_get_library_root('phabricator')).'/webroot/';
$instructions = phutil_safe_html(
FileSystem::readFile($webroot .
PhabricatorEnv::getEnvConfig('todo_guidelines.file')));
}
} else if ($request->getStr('type') == 'Bug') {
$button_name = pht('Report Bug');
$header_name = pht('Report a Bug');
@@ -480,7 +510,6 @@ final class ManiphestTaskEditController extends ManiphestController {
FileSystem::readFile($webroot .
PhabricatorEnv::getEnvConfig('report_guidelines.file')));
}
} else {
$button_name = pht('Create Task');
$header_name = pht('Create New Task');
@@ -606,7 +635,7 @@ final class ManiphestTaskEditController extends ManiphestController {
->setName('projects')
->setValue($projects_value)
->setID($project_tokenizer_id)
->setCaption(pht('Add relevant projects tags here'))
->setCaption(pht('Add relevant projects tags here. In most cases you need to add at least one of BF Blender, Game Engine, Addons or Websites.'))
->setDatasource('/typeahead/common/projects/'));
}

2
webroot/rsrc/custom/static/design_guidelines.html Normal file
View File

@@ -0,0 +1,2 @@
Design tasks are created by developers and module members to work out the design of functionality, and involve the community for feedback. They are not intended to be created by users, rather the focus is always on functionality that developers plan to work on.

35
webroot/rsrc/custom/static/diff_guidelines.html Normal file
View File

@@ -0,0 +1,35 @@
<h2>Where to Submit Patches</h2>
<br/>
<ul>
<li>Create a Diff: if the patch is relatively small, or big but functionality is approved and ready for <a href="http://wiki.blender.org/index.php/Dev:Doc/Tools/Code_Review">Code Review</a>.
<li><a href="/maniphest/task/create/?project=2&type=Patch">Create a Patch Task</a>: if the the patch is big and likely to need more design discussion, feedback or iterations.</li>
</ul>
<br/>
<h2>Documentation</h2>
<br/>
<ul>
<li><a href="http://wiki.blender.org/index.php/Dev:Doc/Process/Patches">Patch Process</a>: how to get your code included.</li>
<li><a href="http://wiki.blender.org/index.php/Dev:Doc/Tools/Code_Review">Code Review</a>: how to use Differential for code review effectively.</li>
</ul>
<br/>
<h2>License</h2>
<br/>
<p>By submitting code here, <b>you agree that the code is (compatible with) GNU GPL v2 or later.</b><br/>
If you choose for a compatible non-GPL license, notify it in the patch.</b></p>
<br>
<h2>Create a Diff</h2>
<br/>
<ul>
<li>Submit patches in svn diff or git diff formats.</li>
<li>Either copy-paste diff content into the text field below, or attach it as file.</li>
<li>You will be able to add a title, description and reviews in the next steps.</li>
<li>If you need to create diffs often, consider setting up <a href="http://wiki.blender.org/index.php/Dev:Doc/Tools/Code_Review#Use_Arcanist">Arcanist</a>.</li>
</ul>

40
webroot/rsrc/custom/static/patch_guidelines.html
View File

@@ -1,9 +1,33 @@
<b>By submitting code to this tracker, you agree that the code is (compatible with) GNU GPL 2 or later.
If you choose for a compatible non-GPL license, notify it in the patch.</b>
<br>
<br><ul>
<li>Submit patches in svn diff or git diff formats.</li>
<li>Either copy-patse patch content into text field below, or attach it as file.</li>
<li>More information about what patch is and how to deal with it, see this
<a href="http://wiki.blender.org/index.php/Dev:Doc/Process/Patches" target="clear">wiki page</a>.</li>
<h2>Where to Submit Patches</h2>
<br/>
<ul>
<li><a href="/differential/diff/create/">Create a Diff</a>: if the patch is relatively small, or big but functionality is approved and ready for <a href="http://wiki.blender.org/index.php/Dev:Doc/Tools/Code_Review">Code Review</a>.
<li>Create a Patch Task: if the the patch is big and likely to need more design discussion, feedback or iterations.</li>
</ul>
<br/>
<h2>Documentation</h2>
<br/>
<ul>
<li><a href="http://wiki.blender.org/index.php/Dev:Doc/Process/Patches">Patch Process</a>: how to get your code included.</li>
<li><a href="http://wiki.blender.org/index.php/Dev:Doc/Tools/Code_Review">Code Review</a>: how to use Differential for code review effectively.</li>
</ul>
<br/>
<h2>License</h2>
<br/>
<p>By submitting code here, <b>you agree that the code is (compatible with) GNU GPL v2 or later.</b><br/>
If you choose for a compatible non-GPL license, notify it in the patch.</b></p>
<br>
<h2>Create a Patch Task</h2>
<br/>
<ul>
<li>Attach any files by drag and drop in the description box.</li>
<li>If you create a diff as well, you can attach it by writing e.g. "Ref T123" in the revision summary, where T123 is the task ID.</li>
</ul>

2
webroot/rsrc/custom/static/todo_guidelines.html Normal file
View File

@@ -0,0 +1,2 @@
To Do tasks are created by developers and module members to track To Do items. They are not intended to be created by users, rather the focus is always on tasks that developers themselves plan to work on.