wallabag/docs/en/Developer/git_repo.html

210 lines
13 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>wallabag - git repository</title>
<link rel="stylesheet" href="http://doc.wallabag.org/css/bootstrap.min.css">
<link rel="stylesheet" href="http://doc.wallabag.org/css/font-awesome.min.css">
<link rel="stylesheet" href="http://doc.wallabag.org/css/highlight.tomorrow-night.css">
<link rel="stylesheet" href="http://doc.wallabag.org/css/main.css">
</head>
<body>
<header class="navbar navbar-default navbar-fixed-top">
<a class="navbar-brand" href="http://doc.wallabag.org/">
wallabag
<small class="hidden-xs hidden-sm">
git repository
</small>
</a>
<a href="http://doc.wallabag.org/en">EN</a> - <a href="http://doc.wallabag.org/fr">FR</a> - <a href="http://doc.wallabag.org/de">DE</a> - <a href="http://doc.wallabag.org/ru">RU</a>
</header>
<main class="container-fluid">
<div class="row">
<nav id="sidebar" class="col-sm-3 col-lg-2" role="navigation">
<ul class="nav nav-pills nav-stacked">
<h4 class="text-muted">
</h4>
<ul class="nav nav-pills nav-stacked">
<li class="test ">
<a href="http://doc.wallabag.org/en/index.html">
Getting started
</a>
</li>
<li class="test ">
<a href="http://doc.wallabag.org/en/help_wallabag.html">
Help us
</a>
</li>
</ul>
<h4 class="text-muted">
Administrator
</h4>
<ul class="nav nav-pills nav-stacked">
<li class="test ">
<a href="http://doc.wallabag.org/en/Administrator/download_and_install.html">
Download and installation
</a>
</li>
<li class="test ">
<a href="http://doc.wallabag.org/en/Administrator/update.html">
Update wallabag
</a>
</li>
<li class="test ">
<a href="http://doc.wallabag.org/en/Administrator/hidden_options.html">
Hidden options
</a>
</li>
<li class="test ">
<a href="http://doc.wallabag.org/en/Administrator/multiusers.html">
Multi users
</a>
</li>
</ul>
<h4 class="text-muted">
User
</h4>
<ul class="nav nav-pills nav-stacked">
<li class="test ">
<a href="http://doc.wallabag.org/en/User/save_your_first_article.html">
Save your first article
</a>
</li>
<li class="test ">
<a href="http://doc.wallabag.org/en/User/read_an_article.html">
Read an article
</a>
</li>
<li class="test ">
<a href="http://doc.wallabag.org/en/User/organize_articles.html">
Organize articles
</a>
</li>
<li class="test ">
<a href="http://doc.wallabag.org/en/User/configure_wallabag.html">
Configure wallabag
</a>
</li>
<li class="test ">
<a href="http://doc.wallabag.org/en/User/search.html">
Search
</a>
</li>
<li class="test ">
<a href="http://doc.wallabag.org/en/User/epub_conversion.html">
ePub conversion
</a>
</li>
<li class="test ">
<a href="http://doc.wallabag.org/en/User/issue_with_article.html">
Issue with article
</a>
</li>
<li class="test ">
<a href="http://doc.wallabag.org/en/User/rss_feed.html">
RSS feed
</a>
</li>
<li class="test ">
<a href="http://doc.wallabag.org/en/User/import_export.html">
Import export
</a>
</li>
<li class="test ">
<a href="http://doc.wallabag.org/en/User/framabag_account_creation.html">
Framabag account creation
</a>
</li>
</ul>
<h4 class="text-muted">
Developer
</h4>
<ul class="nav nav-pills nav-stacked">
<li class="test ">
<a href="http://doc.wallabag.org/en/Developer/write_config_files.html">
Write config files
</a>
</li>
<li class="test ">
<a href="http://doc.wallabag.org/en/Developer/create_new_theme.html">
Create a new theme
</a>
</li>
<li class="test active">
<a href="http://doc.wallabag.org/en/Developer/git_repo.html">
Git repository
</a>
</li>
<li class="test ">
<a href="http://doc.wallabag.org/en/Developer/docker.html">
Docker
</a>
</li>
<li class="test ">
<a href="http://doc.wallabag.org/en/Developer/vagrant.html">
Vagrant
</a>
</li>
<li class="test ">
<a href="http://doc.wallabag.org/en/Developer/v2.html">
wallabag v2 / symfony2
</a>
</li>
</ul>
</ul>
</nav>
<section class="col-lg-10">
<h1 id="git-repository">git repository</h1>
<p>If you wish to contribute to the project by suggesting new features or by fixing some bugs, please follow the recommendations below regarding the git repository available at <a href="https://github.com/wallabag/wallabag"><a href="https://github.com/wallabag/wallabag">https://github.com/wallabag/wallabag</a></a>.</p>
<h2 id="current-state">Current state</h2>
<p>To manage the different versions of wallabag, we use Git.</p>
<p>There are multiple branches for the source code of wallabag web app:</p>
<ul>
<li><code>master</code> branch : this is the stable branch, downloaded by those who wish to install wallabag for their own use.</li>
<li><code>dev</code> branch : before being added on <code>master</code> branch, all bug fixes and new features must go on that branch. This branch is not recommended for production use.</li>
<li><code>v2-symfony</code> branch : this is the branch for a revamp of wallabag. A whole chapter is to be focused on it.</li>
</ul>
<h2 id="workflow">Workflow</h2>
<p>All the rules for contributing to the git repository are in the <a href="https://github.com/wallabag/wallabag/blob/master/contributing.html">CONTRIBUTING.md file of wallabag</a>. Please read carefully this file before you make any change.</p>
</section>
</div>
</main>
<script src="//code.jquery.com/jquery-1.11.0.min.js"></script>
<script src="//netdna.bootstrapcdn.com/bootstrap/3.1.1/js/bootstrap.min.js"></script>
<script src="http://yandex.st/highlightjs/7.5/highlight.min.js"></script>
<script>
$(function() {
$("section>h1").wrap('<div class="page-header" />');
// Syntax highlighting
hljs.initHighlightingOnLoad();
});
</script>
</body>
</html>