repostatus.org

<!doctype html> <html> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="chrome=1"> <title>repostatus.org</title> <link rel="stylesheet" href="stylesheets/styles.css"> <link rel="stylesheet" href="stylesheets/pygment_trac.css"> <link rel="stylesheet" href="stylesheets/samplecode.css"> <meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">  <script src="https://ajax.googleapis.com/ajax/libs/jquery/2.1.3/jquery.min.js"></script> <script type="application/javascript"> var badge_data; $.getJSON('badges/latest/badges.json', function(json){ badge_data = json; }); function showsample(badgename, markup) { outtype = ''; if ( markup == "md" ) { outtype = "Markdown"; } else if ( markup == "rst" ) { outtype = "ReST"; } else if ( markup == "html") { outtype = "HTML"; } $("#sampletitle").html(outtype + " for " + badge_data[badgename]['display_name'] + " Status (<a href=\"https://www.repostatus.org/badges/latest/" + badgename + "_" + markup + ".txt\">direct link</a>)"); $.get('https://www.repostatus.org/badges/latest/' + badgename + '_' + markup + '.txt', function(data) { $("#samplecode").html('<pre>' + htmlEncode(data) + '</pre>'); $("#samplewrapper").show(); }); } function htmlEncode(value) { return $('<div/>').text(value).html(); } </script> </head> <body> <div class="wrapper"> <header> <h1>repostatus.org</h1> <p>A standard to easily communicate to humans and machines the development/support and usability status of software repositories/projects.</p> <p><a href="https://www.repostatus.org/#active"><img src="https://www.repostatus.org/badges/latest/active.svg" alt="Project Status: Active - The project has reached a stable, usable state and is being actively developed." /></a></p> <p class="view"><a href="https://github.com/jantman/repostatus.org">View the Project on GitHub <small>jantman/repostatus.org</small></a></p> <p class="view"><a href="/">Home</a></p> <p class="view"><a href="/history">History</a></p> <p class="view"><a href="/lifecycle">Lifecycle</a></p> <p class="view"><a href="/parsers">Parsers</a></p> <p class="view"><a href="/contributing">Get Involved</a></p> </header> <section> <h2 id="lifecycle">Lifecycle</h2> <p>You can think of respostatus as a way to describe the lifecycle-phase of a project. This may help you to choose an appropriate status for your repositories.</p> <p>Repostatus aims to answer two questions about a repository:</p> <ul> <li>How complete is this? Should I expect it to be “stable” software, mostly working, or not really useful at all?</li> <li>Should I expect active development and support, maybe some bug fixes, or nothing at all?</li> </ul> <p>We wish to talk about whether the content of a repository is in a usable state and how much support from contributors can be expected. Thus statuses can be divided along two axes: usability and support.</p> <p><img src="/images/lifecycle.svg" alt="Flowdiagram representation of a typical lifecycle." /></p> <p>As illustrated above the statuses of a repository can be split into two groups: unstable repos and stable repos.</p> <h3 id="unstable-repos">Unstable repos</h3> <p>These repositories have not yet reached a stable and usable state. You should expect them to change frequently and dramatically.</p> <p>All repositories start as a Concept. They are little more than an idea yet. From here we might abandon the project or start to work on it in ernest. Only once a repository was a WIP can it be suspended, work on it be put aside to be continued later. To reach a stable state some work is needed thus WIP is the only state from which we can feasibly move towards a stable state.</p> <h3 id="stable-repos">Stable repos</h3> <p>A repository will reach a stable state as something that is actively worked on. Thus all repositories will move into the second group of states as Active. From here they might become Inactive or Unsupported. Contrary to the unstable states it is totally feasable for a repository to move from any stable state into any other stable state.</p> <h3 id="moved">Moved</h3> <p>A special case is the <em>Moved</em> state for repositories. Any repository can move to be <em>Moved</em> from any state. As this states indicates that another repository will contain the actual state of the project, such as when a project moves from GitLab to GitHub or when the initial maintainer hands the project over to a fork and it’s maintainers.</p> <h2 id="real-life-application">Real life application</h2> <p>Understanbly many repositories will not strictly follow the lifecycle outlined here. When a few commits move a repo from <em>Suspended</em> to <em>Active</em> it is understandable that maintners might not want to make another commit just to move it to <em>WIP</em>.</p> <p>We fully understand that states as outlined here will be skipped. Therefore the lifecycle hopes to outline a way of thinking about the status of a repository and help choose an appropriate status.</p> </section> <footer> <p>This project is maintained by <a href="https://github.com/jantman">jantman</a></p> <p><small>Hosted on GitHub Pages — Theme by <a href="https://github.com/orderedlist">orderedlist</a></small></p> <p><a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-sa/4.0/88x31.png" /></a></p> </footer> </div> <script src="javascripts/scale.fix.js"></script> </body> </html>

CINXE.COM

repostatus.org