Skip to content

Commit 3178ea9

Browse files
committed
First content draft
1 parent 45289d7 commit 3178ea9

9 files changed

+197
-167
lines changed

_config.yml

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,17 @@
66
# 'jekyll serve'. If you change this file, please restart the server process.
77

88
# Site settings
9-
title: Your awesome title
10-
9+
title: Humanitarian Toolbox Developer Guide
10+
1111
description: > # this means to ignore newlines until "baseurl:"
1212
Write an awesome description for your new site here. You can edit this
1313
line in _config.yml. It will appear in your document head meta (for
1414
Google search results) and in your feed.xml site description.
1515
baseurl: "" # the subpath of your site, e.g. /blog
1616
url: "http://yourdomain.com" # the base hostname & protocol for your site
17-
twitter_username: jekyllrb
18-
github_username: jekyll
17+
twitter_username: htbox
18+
github_username: htbox
1919

2020
# Build settings
2121
markdown: kramdown
22+

_posts/2015-11-14-welcome-to-jekyll.markdown

Lines changed: 0 additions & 162 deletions
This file was deleted.

building-the-project.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
layout: default
3+
---
4+
#Building the project
5+
6+
##TL;DR version
7+
8+
It's likely a Visual Studio based .NET project. Load the appropriate .sln and buld.
9+
10+
##Longer version:
11+
12+
Some of our projects have both web and mobile components. Those will have a master solution,
13+
that builds everything. They will also have a -web solution that only builds the web based
14+
application. They may also have a -mobile solution that builds only the mobile applications.
15+
16+
Load the appropriate solution, and build it.
17+
18+
All our projects have some unit tests. The amount of coverage varies with the origins
19+
of the projects. In all cases, we encourage contributors to help add to the unit test coverage.at whatever adfadf
20+
For those projects where we do have good coverage, we may even reject pull requests without
21+
the addition of new tests that exercise the code being developed.
22+

doing-the-work.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
layout: default
3+
---
4+
5+
#Doing the work
6+
7+
##TL;DR version
8+
9+
Work as you normally would, commit and push your changes at the cadence that works for you.
10+
Please make one Pull Request for one Issue, rather than fixing several issues in on PR. It's much
11+
easier for us to review and merge when a PR is focused on one issue.
12+
13+
##Long Version:
14+
15+
There are a few steps here that can help us review your pull request and ensure a smooth process
16+
when we take your code. All the tips described here make it easier for us to merge your changes
17+
with changes being made by other developers.
18+
19+
On at least a daily basis, rebase the changes you are making on the master branch <link>. This
20+
ensures that when you have completed your work, it merges easily into the master branch.
21+
22+
We recommending rebasing instead of merging the master branch into your fork because thaA creates a
23+
cleaner pull request.
24+
25+
Consider squash commits. A squash commit combines several original commit actions into one commit.
26+
The result is a single commit that shows all your changes. This isn't necessary, but if you are
27+
comfortable doing it, please do.
28+

finding-a-task.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
layout: default
3+
---
4+
5+
#Finding A Task
6+
7+
##TL;DR version:
8+
9+
Look at the issues page for a project, select the Milestones tabl, and select the current
10+
milestone. Those are the items for the current sprint. If this is your first time helping us,
11+
look for issues tagged with the 'JumpIn' label. When you find one you like, write a comment saying
12+
"I'll work on this". One of the team will reach out to you, and see if you have any questions.
13+
14+
##Long Version
15+
16+
We use Github issues to manage work. This could be proposed features, tasks under a feature, bugs,
17+
and suggestions. We manage the backlog by using Milestones. Every project has a current milestone, and a
18+
backlog milestone. Issues assigned to the current milestone represent priority items in the current
19+
sprint. Issues assigned to the backlog milestone have been triaged and accepted, but have not been assigned any
20+
specific milestone.
21+
22+
Some projects have other upcoming milestones, based on customer needs, upcoming pilots, or upcoming
23+
releases.
24+
25+
In addition, we label issues to provide some additional guidance. Withing a milestone, we will use the 'P1',
26+
'P2' and 'P3' milestones to mark the priority of a task or feature. (P1 is the highest, P3 is the lowest.)
27+
In addition, we use the 'JumpIn' label (which is always green on our projects) to denote issues that would
28+
be suitable for someone not yet familiar with the project. The 'JumpIn' issues may not always represent
29+
simple fixes, but they do represent work that does not require a deep knowlege of the code base, or a deep
30+
knowledge of the business workflow for a project.
31+
32+
Other labels are project-specific and will be documented for that project.
33+
34+
Tag yourself in a comment saying that you're working on an issue, and we'll start the converation.
35+
36+
You may notice that you can't assign yourself to work on an issue. That privilege is limited to the
37+
core team. Also, we can only assign issues to registered team members. If you enjoy
38+
working on our projects, we'll add you to the team, and we will assign tasks when you tag yourself.
39+

getting-the-code.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
layout: default
3+
---
4+
5+
#Getting the Code
6+
7+
##TL;DR version
8+
9+
Fork the repository. Clone your fork using your favorite Git client tool
10+
11+
##Long version:
12+
13+
We use the Github Flow process on all our projects (link). That means you are not commiting your
14+
changes directly to our repositories. Instead, you will submit a Pull Request for one of the
15+
lead committers to pull your changes into our repository. That enables us to review your
16+
changes, and discuss them with you. We even use this process ourselves: other core team members
17+
review our changes and pull them into the repository.
18+
19+
The first step in this process is to get the code onto your machine, configured with a
20+
github repository where you can commit your changes. You do that by creating a fork of
21+
the project repository in your account. You (and only you) have write access to your fork.
22+
23+
Now, you can clone your fork onto your desktop. You'll commit your changes locally, and
24+
then push them to your fork on github.

index.html

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,33 @@
44

55
<div class="home">
66

7-
<h1 class="page-heading">Posts</h1>
7+
<h1 class="page-heading">Contributing to HTBox Projects</h1>
8+
<h2>Introduction</h2>
9+
<p>
10+
All of our projects are Open Source, and released under the MIT license. Before you do anything,
11+
ensure that working on our projects does not conflict with any of your employee agreements.
12+
</p>
13+
<p>
14+
We manage project workflow using a form of 'volunteer scrum' process. It's essentially scrum,
15+
but because we know everyone is a volunteer, we expect large flucuations in velocity. We
16+
also know that our volunteers have other committments, and may need to pull away from an
17+
assigned task before it's completed.
18+
</p>
19+
<p>
20+
21+
The remainder of this document explains how our projects are organized, how to assign
22+
yourself work, and how to sumbit that work for review. We'll also explain how to submit ideas
23+
for work that you want to do to enhnce our projects.
24+
</p>
25+
26+
<h2><a href="/finding-a-task.html">Finding a Task</a></h2>
27+
<h2><a href="/getting-the-code.html">Getting the Code</a></h2>
28+
<h2><a href="/building-the-project.html">Building the Project</a></h2>
29+
<h2><a href="/doing-the-work.html">Doing the Work</a></h2>
30+
<h2><a href="/submitting-a-pull-request.html">Submitting a Pull Request</a></h2>
31+
<h2><a href="/responding-to-reviews.html">Responding to Reviews</a></h2>
32+
<h1>FAQ</h1>
33+
As we create FAQ items will will post them here:
834

935
<ul class="post-list">
1036
{% for post in site.posts %}

responding-to-reviews.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
layout: default
3+
---
4+
5+
6+
#Responding to Reviews
7+
8+
##TL;DR;
9+
10+
If you update your code, and push to your fork, github automatically updates the PR. We'll see the
11+
changes. If you disagree with the review, please comment on the code, and tell us why your
12+
approach is better. We may or may not approve it, but we will listen.
13+
14+
##Long Version
15+
16+
Reviews are especially important when you are making your first PR for us. It's a way to have
17+
a conversation about the code as you make it. We appreciate the volunteer contributions we receive, and
18+
we value your time. We'd rather help comment early then reject work.
19+
20+
We review PRs (even WIP PRs) once a day, and we will give actionable feedback. Please respond in the
21+
same tone we use. We want great projects, and we respect your time and contribution. The people reviewing
22+
code are also volunteers and expect to receive the same respect.

submitting-a-pull-request.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
layout: default
3+
---
4+
5+
#Submitting a Pull Request
6+
7+
##TL;DR;
8+
9+
When you're doing with an issue, submit a pull request and we'll take a look.
10+
11+
##Long Version;
12+
13+
You don't have to wait until all your work is done in order to send us a pull request. If you want
14+
the core team to look at your code, but not accept the changes yet, open a pull request, and prefix the
15+
title with 'WIP'. That tells us to review the code, but that it is not done, and is not yet ready to merge.
16+
When you are finished, and the PR is ready to merge, simply remove 'WIP' from the PR tktle, and we'll
17+
give it a final look, and merge it.
18+
19+
When you submit a pull request, an automated build (using AppVeyor) will merge your changes onto
20+
a copy of the master repository, build that configuration, and run all automated tests.
21+
22+
If any of those steps fail, we will ask you to fix them before we accept the pull request. (We don't
23+
comment on this if you've labelled the PR 'WIP'.)
24+
25+
We ask you to resolve any merge conflicts because you know your code the best. This article <link>
26+
shows how to update your fork from master.
27+
28+
Ideally, you can rebase your changes on the lastest version of mster. Here's a quick video that
29+
shows how to do that.
30+

0 commit comments

Comments
 (0)