Skip to content

Commit

Permalink
Added Github templates
Browse files Browse the repository at this point in the history
  • Loading branch information
rdoursenaud committed Feb 22, 2016
1 parent 6ab8ba1 commit d7304e5
Show file tree
Hide file tree
Showing 5 changed files with 93 additions and 4 deletions.
11 changes: 9 additions & 2 deletions CONTRIBUTING.md → .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,13 @@ Use clear commit messages with the following structure:
LONGDESC
```

We provide a [.gitmessage](/.gitmessage) file to help you fit the template.

You can add it to your git configuration using:
```
git config --local commit.template .gitmessage
```

#### Keyword
In uppercase if you want to have the log comment appears into the generated ChangeLog file.

Expand Down Expand Up @@ -100,9 +107,9 @@ Otherwise, please be a bit verbose about what you're providing.
Your Pull Request must pass the Continuous Integration checks.
Also, some code changes need a prior approbation:

* if you want to include a new external library (into htdocs/includes directory), please ask before to the project leader to see if such a library can be accepted.
* if you want to include a new external library (into htdocs/includes directory), please ask before to the project manager (@eldy) to see if such a library can be accepted.

* if you add a new table, you must first create a page on http://wiki.dolibarr.org/index.php/Category:Table_SQL (copy an existing page changing its name to see it into this index page). Than ask the project leader if the new data model you plan to add can be accepted as you suggest.
* if you add a new table, you must first create a page on http://wiki.dolibarr.org/index.php/Category:Table_SQL (copy an existing page changing its name to see it into this index page). Than ask the project manager (@eldy) if the new data model you plan to add can be accepted as you suggest.

### Resources
[Developer documentation](http://wiki.dolibarr.org/index.php/Developer_documentation)
Expand Down
50 changes: 50 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# Instructions

*This is a template to help you report good issues.*

*You may use [Github Markdown](https://help.github.com/articles/getting-started-with-writing-and-formatting-on-github/) syntax to format your issue report.*

*Please:*
- [ ] *follow the project [contributing guidelines](/.github/CONTRIBUTING.md)*
- [ ] *only keep the "Bug" or "Feature Request" section*
- [ ] *replace the bracket enclosed texts with meaningful informations*
- [ ] *remove any unused sub-section*


# Bug
[*Short description*]

## Environment
- **Version**: [*Affected Dolibarr version(s)*]
- **OS**: [*Server OS type and version*]
- **Web server**: [*Webserver type and version*]
- **PHP**: [*PHP version*]
- **Database**: [*Database type and version*]
- **URL(s)**: [*Affected URL(s)*]

## Report

### Expected behavior
[*Verbose description*]

### Actual behavior
[*Verbose description*]

### Steps to reproduce the behavior
[*Verbose description*]

### [Attached files](https://help.github.com/articles/issue-attachments) (Screenshots, screencasts, dolibarr.log, debugging informations…)
[*Files*]


# Feature Request
[*Short description*]

## Use case
[*Verbose description*]

## Suggested implementation
[*Verbose description*]

## Tasks
[*List of tasks to achieve goal*]
22 changes: 22 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Instructions

*This is a template to help you make good pull requests.*

*You may use [Github Markdown](https://help.github.com/articles/getting-started-with-writing-and-formatting-on-github/) syntax to format your issue report.*

*Please:*
- [ ] *follow the project [contributing guidelines](/.github/CONTRIBUTING.md)*
- [ ] *only keep the "Fix", "Close" or "New" section*
- [ ] *replace the bracket enclosed textswith meaningful informations*


# Fix #[*issue_number Short description*]
[*Long description*]


# Close #[*issue_number Short description*]
[*Long description*]


# New [*Short description*]
[*Long description*]
7 changes: 7 additions & 0 deletions .gitmessage
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@

# ^=[ Subject: One line short summary ]=========^|
# ~ Subject template: [KEYWORD] [ISSUENUM] DESC ~|

# ^=[ Blank: Follow the Subject with a blank line, do NOT remove ]====^|

# ^=[ Details: Describe what changed and explain why it changed ]=====^|
7 changes: 5 additions & 2 deletions htdocs/main.inc.php
Original file line number Diff line number Diff line change
Expand Up @@ -1739,15 +1739,18 @@ function left_menu($menu_array_before, $helppagename='', $notused='', $menu_arra
$bugbaseurl.= '?title=';
$bugbaseurl.= urlencode("Bug: ");
$bugbaseurl.= '&body=';
$bugbaseurl.= urlencode("# Environment\n");
// FIXME: use .github/ISSUE_TEMPLATE.md to generate?
$bugbaseurl .= urlencode("# Bug\n");
$bugbaseurl .= urlencode("\n");
$bugbaseurl.= urlencode("## Environment\n");
$bugbaseurl.= urlencode("- **Version**: " . DOL_VERSION . "\n");
$bugbaseurl.= urlencode("- **OS**: " . php_uname('s') . "\n");
$bugbaseurl.= urlencode("- **Web server**: " . $_SERVER["SERVER_SOFTWARE"] . "\n");
$bugbaseurl.= urlencode("- **PHP**: " . php_sapi_name() . ' ' . phpversion() . "\n");
$bugbaseurl.= urlencode("- **Database**: " . $db::LABEL . ' ' . $db->getVersion() . "\n");
$bugbaseurl.= urlencode("- **URL**: " . $_SERVER["REQUEST_URI"] . "\n");
$bugbaseurl.= urlencode("\n");
$bugbaseurl.= urlencode("# Report\n");
$bugbaseurl.= urlencode("## Report\n");
print '<div id="blockvmenuhelpbugreport" class="blockvmenuhelp">';
print '<a class="help" target="_blank" href="'.$bugbaseurl.'">'.$langs->trans("FindBug").'</a>';
print '</div>';
Expand Down

0 comments on commit d7304e5

Please sign in to comment.