initial split of contributing
This commit is contained in:
Justin Cooper
parent
e2e8f435b3
commit
47bca31093
5 changed files with 139 additions and 122 deletions
32
_layouts/contributing.html
Normal file
32
_layouts/contributing.html
Normal file
|
|
@ -0,0 +1,32 @@
|
|||
---
|
||||
layout: default
|
||||
---
|
||||
|
||||
<!-- https://github.com/adafruit/circuitpython/issues/1246 -->
|
||||
|
||||
<div id="libraries-page" class="common-layout">
|
||||
<div class="content">
|
||||
<h1>Contributing</h1>
|
||||
<p>
|
||||
If you'd like to contribute to the CircuitPython project, the CircuitPython
|
||||
libraries are a great way to begin. This page is updated weekly with status
|
||||
information from the CircuitPython libraries, including open issues and
|
||||
repo-level issues.
|
||||
</p>
|
||||
<p>
|
||||
If this is your first time contributing, or you'd
|
||||
like to see our recommended contribution workflow, we have a guide on
|
||||
<a href="https://learn.adafruit.com/contribute-to-circuitpython-with-git-and-github">Contributing to CircuitPython with Git and Github</a>.
|
||||
You can also find us in the #circuitpython channel on the
|
||||
<a href="https://adafru.it/discord">Adafruit Discord</a>.
|
||||
</p>
|
||||
<p>
|
||||
Have an idea for a new driver or library?
|
||||
<a href="https://github.com/adafruit/circuitpython/issues">File an issue on the CircuitPython repo!</a>
|
||||
</p>
|
||||
<h2>Current Status for Week of {{ site.data.libraries.updated_at | date: "%a, %b %d, %Y" }}</h2>
|
||||
{{ content }}
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<script src="/assets/javascript/contributing.js"></script>
|
||||
|
|
@ -1,122 +0,0 @@
|
|||
---
|
||||
layout: default
|
||||
title: Libraries - Contributing
|
||||
permalink: /libraries/contributing
|
||||
---
|
||||
|
||||
<!-- https://github.com/adafruit/circuitpython/issues/1246 -->
|
||||
|
||||
<div id="libraries-page" class="common-layout">
|
||||
<div class="content">
|
||||
<h1>Contributing</h1>
|
||||
<p>
|
||||
If you'd like to contribute to the CircuitPython project, the CircuitPython
|
||||
libraries are a great way to begin. This page is updated weekly with status
|
||||
information from the CircuitPython libraries, including open issues and
|
||||
repo-level issues.
|
||||
</p>
|
||||
<p>
|
||||
If this is your first time contributing, or you'd
|
||||
like to see our recommended contribution workflow, we have a guide on
|
||||
<a href="https://learn.adafruit.com/contribute-to-circuitpython-with-git-and-github">Contributing to CircuitPython with Git and Github</a>.
|
||||
You can also find us in the #circuitpython channel on the
|
||||
<a href="https://adafru.it/discord">Adafruit Discord</a>.
|
||||
</p>
|
||||
<p>
|
||||
Have an idea for a new driver or library?
|
||||
<a href="https://github.com/adafruit/circuitpython/issues">File an issue on the CircuitPython repo!</a>
|
||||
</p>
|
||||
<h2>Current Status for Week of {{ site.data.libraries.updated_at | date: "%a, %b %d, %Y" }}</h2>
|
||||
<p>
|
||||
This is the current status of open pull requests and issues across all of the library repos.
|
||||
</p>
|
||||
<div class="libraries open-pull-requests">
|
||||
<h3>Open Pull Requests</h3>
|
||||
<ul>
|
||||
{% for library in site.data.libraries.pull_requests %}
|
||||
<li>
|
||||
{{library[0]}}
|
||||
<ul>
|
||||
{% for issue in library[1] %}
|
||||
{% for details in issue %}
|
||||
<li><a href="{{ details[0] }}">{{ details[1] }}</a></li>
|
||||
{% endfor %}
|
||||
{% endfor %}
|
||||
</ul>
|
||||
</li>
|
||||
{% endfor %}
|
||||
</ul>
|
||||
</div>
|
||||
<div class="libraries open-issues">
|
||||
{% comment %}
|
||||
create labels array by looping through labels of each issue
|
||||
ensuring unique for select list
|
||||
{% endcomment %}
|
||||
{% assign labels = "All" | split: "," %}
|
||||
{% for library in site.data.libraries.open_issues %}
|
||||
{% for issue in library[1] %}
|
||||
{% for label in issue.labels %}
|
||||
{% assign labels = labels | push: label | uniq %}
|
||||
{% endfor %}
|
||||
{% endfor %}
|
||||
{% endfor %}
|
||||
<select>
|
||||
{% for label in labels %}
|
||||
<option value='{{ label | downcase | replace: ' ', '-' }}'>{{ label | capitalize }}</option>
|
||||
{% endfor %}
|
||||
<select>
|
||||
<h3>Open Issues</h3>
|
||||
<ul>
|
||||
{% for library in site.data.libraries.open_issues %}
|
||||
<li>
|
||||
{{library[0]}}
|
||||
<ul class="issues-list">
|
||||
{% for issue in library[1] %}
|
||||
{% capture classes %}
|
||||
{% for label in issue.labels %}
|
||||
{{ label | downcase | replace: ' ', '-' }}
|
||||
{% endfor %}
|
||||
{% endcapture %}
|
||||
<li class="{{ classes | strip }}"><a href="{{ issue.url }}">{{ issue.title }}</a></li>
|
||||
{% endfor %}
|
||||
</ul>
|
||||
</li>
|
||||
{% endfor %}
|
||||
</ul>
|
||||
</div>
|
||||
<h2>Library Infrastructure Issues</h2>
|
||||
<p>
|
||||
The following are issues with the library infrastructure. Having a standard library structure
|
||||
greatly improves overall maintainability. Accordingly, we have a series of checks to ensure
|
||||
the standard is met. Most of these are changes that can be made via a pull request, however
|
||||
there are a few checks reported here that require changes to GitHub settings. If you are
|
||||
interested in addressing any of these issues, please feel free to contact us with any questions.
|
||||
</p>
|
||||
<p>
|
||||
If you're looking for a Good First Issue to begin contributing, consider the two issues related to
|
||||
example naming: "Example file(s) missing sensor/library name." and "Missing simpletest example."
|
||||
Every repo should have a <code>libraryname_simpletest.py</code> file in the examples folder at a
|
||||
minimum. Any other included examples should be prefixed with <code>libraryname_</code> so all
|
||||
examples found in any given repo folder start with the library name followed by an underscore.
|
||||
The GitHub end of things is a simple fix, however, please be aware many examples are linked in
|
||||
Learn guides. You should mention in your pull request that it is possible that guides will
|
||||
require updating to match the new example name.
|
||||
</p>
|
||||
<div class="libraries">
|
||||
<ul>
|
||||
{% for repo_issue in site.data.libraries.repo_infrastructure_errors %}
|
||||
<li>
|
||||
{{repo_issue[0]}}
|
||||
<ul>
|
||||
{% for issue in repo_issue[1] %}
|
||||
<li><a href="{{ issue | split: " " | first }}">{{ issue }}</a></li>
|
||||
{% endfor %}
|
||||
</ul>
|
||||
</li>
|
||||
{% endfor %}
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<script src="/assets/javascript/contributing.js"></script>
|
||||
38
libraries/contributing/library_infrastructure.html
Normal file
38
libraries/contributing/library_infrastructure.html
Normal file
|
|
@ -0,0 +1,38 @@
|
|||
---
|
||||
layout: contributing
|
||||
title: Libraries - Contributing - Library Infrastructure Issues
|
||||
permalink: /libraries/contributing/library-infrastructure-issues
|
||||
---
|
||||
|
||||
<h2>Library Infrastructure Issues</h2>
|
||||
<p>
|
||||
The following are issues with the library infrastructure. Having a standard library structure
|
||||
greatly improves overall maintainability. Accordingly, we have a series of checks to ensure
|
||||
the standard is met. Most of these are changes that can be made via a pull request, however
|
||||
there are a few checks reported here that require changes to GitHub settings. If you are
|
||||
interested in addressing any of these issues, please feel free to contact us with any questions.
|
||||
</p>
|
||||
<p>
|
||||
If you're looking for a Good First Issue to begin contributing, consider the two issues related to
|
||||
example naming: "Example file(s) missing sensor/library name." and "Missing simpletest example."
|
||||
Every repo should have a <code>libraryname_simpletest.py</code> file in the examples folder at a
|
||||
minimum. Any other included examples should be prefixed with <code>libraryname_</code> so all
|
||||
examples found in any given repo folder start with the library name followed by an underscore.
|
||||
The GitHub end of things is a simple fix, however, please be aware many examples are linked in
|
||||
Learn guides. You should mention in your pull request that it is possible that guides will
|
||||
require updating to match the new example name.
|
||||
</p>
|
||||
<div class="libraries">
|
||||
<ul>
|
||||
{% for repo_issue in site.data.libraries.repo_infrastructure_errors %}
|
||||
<li>
|
||||
{{repo_issue[0]}}
|
||||
<ul>
|
||||
{% for issue in repo_issue[1] %}
|
||||
<li><a href="{{ issue | split: " " | first }}">{{ issue }}</a></li>
|
||||
{% endfor %}
|
||||
</ul>
|
||||
</li>
|
||||
{% endfor %}
|
||||
</ul>
|
||||
</div>
|
||||
43
libraries/contributing/open_issues.html
Normal file
43
libraries/contributing/open_issues.html
Normal file
|
|
@ -0,0 +1,43 @@
|
|||
---
|
||||
layout: contributing
|
||||
title: Libraries - Contributing - Open Issues
|
||||
permalink: /libraries/contributing/open-issues
|
||||
---
|
||||
|
||||
<div class="libraries open-issues">
|
||||
{% comment %}
|
||||
create labels array by looping through labels of each issue
|
||||
ensuring unique for select list
|
||||
{% endcomment %}
|
||||
{% assign labels = "All" | split: "," %}
|
||||
{% for library in site.data.libraries.open_issues %}
|
||||
{% for issue in library[1] %}
|
||||
{% for label in issue.labels %}
|
||||
{% assign labels = labels | push: label | uniq %}
|
||||
{% endfor %}
|
||||
{% endfor %}
|
||||
{% endfor %}
|
||||
<select>
|
||||
{% for label in labels %}
|
||||
<option value='{{ label | downcase | replace: ' ', '-' }}'>{{ label | capitalize }}</option>
|
||||
{% endfor %}
|
||||
<select>
|
||||
<h3>Open Issues</h3>
|
||||
<ul>
|
||||
{% for library in site.data.libraries.open_issues %}
|
||||
<li>
|
||||
{{library[0]}}
|
||||
<ul class="issues-list">
|
||||
{% for issue in library[1] %}
|
||||
{% capture classes %}
|
||||
{% for label in issue.labels %}
|
||||
{{ label | downcase | replace: ' ', '-' }}
|
||||
{% endfor %}
|
||||
{% endcapture %}
|
||||
<li class="{{ classes | strip }}"><a href="{{ issue.url }}">{{ issue.title }}</a></li>
|
||||
{% endfor %}
|
||||
</ul>
|
||||
</li>
|
||||
{% endfor %}
|
||||
</ul>
|
||||
</div>
|
||||
26
libraries/contributing/pull_requests.html
Normal file
26
libraries/contributing/pull_requests.html
Normal file
|
|
@ -0,0 +1,26 @@
|
|||
---
|
||||
layout: contributing
|
||||
title: Libraries - Contributing - Pull Requests
|
||||
permalink: /libraries/contributing
|
||||
---
|
||||
|
||||
<p>
|
||||
This is the current status of open pull requests and issues across all of the library repos.
|
||||
</p>
|
||||
<div class="libraries open-pull-requests">
|
||||
<h3>Open Pull Requests</h3>
|
||||
<ul>
|
||||
{% for library in site.data.libraries.pull_requests %}
|
||||
<li>
|
||||
{{library[0]}}
|
||||
<ul>
|
||||
{% for issue in library[1] %}
|
||||
{% for details in issue %}
|
||||
<li><a href="{{ details[0] }}">{{ details[1] }}</a></li>
|
||||
{% endfor %}
|
||||
{% endfor %}
|
||||
</ul>
|
||||
</li>
|
||||
{% endfor %}
|
||||
</ul>
|
||||
</div>
|
||||
Loading…
Reference in a new issue