-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
a075c3c
commit f0fdc35
Showing
2 changed files
with
23 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
Code | ||
==== | ||
|
||
Reminders | ||
--------- | ||
|
||
- `Manage technical debt <https://tashian.com/articles/managing-technical-debt/>`__. | ||
- Instead of writing a ``TODO`` comment in the code, create an issue on GitHub. TODO’s in code are less visible to the rest of the team. | ||
|
||
.. _scripts: | ||
|
||
Scripts | ||
------- | ||
|
||
- For builds that involve independent command-line tools, use `Make <https://www.gnu.org/software/make/>`__, and follow DataMade's `Making Data Guidelines <https://github.com/datamade/data-making-guidelines>`__ and Clark Grubb's `Makefile Style Guide <https://clarkgrubb.com/makefile-style-guide>`__. | ||
|
||
- Examples: `standard_profile_template <https://github.com/open-contracting/standard_profile_template>`__ | ||
|
||
- If a repository has scripts to set itself up and/or update itself, follow GitHub's `Scripts to Rule Them All <https://github.com/github/scripts-to-rule-them-all>`__. | ||
|
||
- Examples: `deploy <https://github.com/open-contracting/deploy/tree/master/script>`__, `standard_profile_template <https://github.com/open-contracting/standard_profile_template/tree/master/script>`__ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,4 +3,6 @@ General | |
|
||
.. toctree:: | ||
|
||
code | ||
documentation | ||
preferences |