Difference between revisions of "Bug fixing pipeline"

From BlackBox Framework Wiki
Jump to: navigation, search
(Created page with "To fix some bug or invent any feature, Center member should led further pipeline: # [http://redmine.blackboxframework.org/projects/blackbox/issues/new Create the issue] i...")
 
(Before voting)
 
(17 intermediate revisions by 2 users not shown)
Line 1: Line 1:
To fix some bug or invent any feature, [[Center]] member should led further pipeline:
+
To fix some bug or create a new [[Center]] feature a member should follow these instructions:
  
# [http://redmine.blackboxframework.org/projects/blackbox/issues/new Create the issue] in the Center Issues tracker and get the unique issue number '''N'''.
+
# [http://redmine.blackboxframework.org/projects/blackbox/issues/new Create the issue] in the Center Issues tracker with a unique issue number '''N''' and make full description of the problem and it's solution if such exists
# Create the branch with GitHub online interface with name "issue-#'''N'''" (see image bellow)
+
# Create the branch with GitHub online interface with name "issue-#'''N'''" ([[Media:Makebranch.png]])
# Create the topic in the [http://forum.blackboxframework.org/viewforum.php?f=39 issues discussion section] of the Center Board with full description of the problem and your solution if such exists
+
# Create the topic in the [http://forum.blackboxframework.org/viewforum.php?f=39 issues discussion section] of the Center Board with a reference to the issue description
  
Further actions need Center members for discussion and coding, [[Chair]] for creating the voting. After the positive voting the topic branch should be merged with master branch in web-interface of GitHub.
+
Further actions need discussion and coding by Center members. The [[Chair]] will then create a vote. If the vote passes, the topic branch should be merged with the master branch in the web-interface of GitHub.
  
 
== Before voting ==
 
== Before voting ==
Line 11: Line 11:
 
Before voting about any issue-#N it is good to have a trial version of BlackBox with all fixes.
 
Before voting about any issue-#N it is good to have a trial version of BlackBox with all fixes.
 
For doing this you need to work with Git a bit:
 
For doing this you need to work with Git a bit:
# clone the repository from GitHub,
 
# switch to branch "issue-#N",
 
# make changes and commit them with some message containing description + "Refs. #N."
 
# push this commit to repository
 
  
More information can be found here: [[How to develop with Git]].
+
0. Add your ssh-key to GitHub: http://github.com/settings/keys
 +
 
 +
1. Clone the repository from GitHub
 +
git clone git@github.com:BlackBoxCenter/blackbox.git
 +
2. Switch to branch "issue-#N",
 +
git checkout issue-#N
 +
3. Make changes and commit them with some message containing description + "Refs. #N."
 +
git commit -a -m "The description. Refs. #N."
 +
4. Push this commit to repository
 +
git push
  
 
Then [[The BlackBox Build Engine]] will prepare a demo BlackBox automatically here:
 
Then [[The BlackBox Build Engine]] will prepare a demo BlackBox automatically here:
 
http://blackboxframework.org/unstable
 
http://blackboxframework.org/unstable
  
However this work is not necessary, you can just post the annotated solution in the forum and the admin of [[Chair]] will execute this.
+
The repository contains only sources, so for editing at the third step you need to use other copy of BlackBox or to build BlackBox from sources using the instructions from README file.
  
 +
More information can be found here: [[How to develop with Git]].
  
== Illustrations ==
+
However this work is not necessary, you can just post the annotated solution in the forum and the admin of [[Chair]] will execute this.
 
+
Creating the branch with GitHub online interface:
+
 
+
[[File:Makebranch.png]]
+

Latest revision as of 02:39, 27 April 2016

To fix some bug or create a new Center feature a member should follow these instructions:

  1. Create the issue in the Center Issues tracker with a unique issue number N and make full description of the problem and it's solution if such exists
  2. Create the branch with GitHub online interface with name "issue-#N" (Media:Makebranch.png)
  3. Create the topic in the issues discussion section of the Center Board with a reference to the issue description

Further actions need discussion and coding by Center members. The Chair will then create a vote. If the vote passes, the topic branch should be merged with the master branch in the web-interface of GitHub.

Before voting

Before voting about any issue-#N it is good to have a trial version of BlackBox with all fixes. For doing this you need to work with Git a bit:

0. Add your ssh-key to GitHub: http://github.com/settings/keys

1. Clone the repository from GitHub

git clone git@github.com:BlackBoxCenter/blackbox.git

2. Switch to branch "issue-#N",

git checkout issue-#N

3. Make changes and commit them with some message containing description + "Refs. #N."

git commit -a -m "The description. Refs. #N."

4. Push this commit to repository

git push

Then The BlackBox Build Engine will prepare a demo BlackBox automatically here: http://blackboxframework.org/unstable

The repository contains only sources, so for editing at the third step you need to use other copy of BlackBox or to build BlackBox from sources using the instructions from README file.

More information can be found here: How to develop with Git.

However this work is not necessary, you can just post the annotated solution in the forum and the admin of Chair will execute this.