Update templating text (#28)

* Update language

* Include custom style

Author: g4brielvs

.github/CONTRIBUTING.md

@@ -0,0 +1,45 @@
+# CONTRIBUTING
+
+Thank you for considering contributing! We appreciate your interest in helping us improve our project. By contributing, you agree to abide by our [Code of Conduct](docs/CODE_OF_CONDUCT.md).
+
+Please take a moment to review this document for important information on how to contribute effectively.
+
+## How Can I Contribute?
+
+There are several ways you can contribute to this project:
+
+- **Bug Reports:** If you encounter a bug or unexpected behavior, please open an issue on our GitHub issue tracker. Be sure to include as much detail as possible to help us identify and fix the problem.
+
+- **Feature Requests**: If you have an idea for a new feature or enhancement, please open an issue on our GitHub issue tracker and label it as a "feature request." Describe the feature and its use case in detail.
+
+- **Pull Requests:** If you'd like to contribute code or documentation changes, we encourage you to submit a pull request (PR). Please follow the guidelines outlined in the [Contributing Code](CONTRIBUTING.md) section below.
+
+- **Documentation:** If you find any errors or have suggestions for improving our documentation, you can submit changes directly through a pull request.
+
+- **Community Engagement:** Help answer questions and engage with other users and contributors on our GitHub Discussions (if applicable).
+
+## Contributing Code
+
+If you're contributing code, please follow these guidelines:
+
+1. **Fork the Repository**: Click the "Fork" button on the top-right corner of this repository on GitHub. This will create a copy of the project in your GitHub account.
+
+2. **Create a Branch:** Create a new branch for your feature or bug fix. Use a clear and descriptive name for your branch, like `feature/my-new-feature` or `bugfix/issue-123`.
+
+3. **Make Changes:** Make your code changes and ensure they adhere to our coding standards.
+
+4. **Test:** Ensure that your changes do not break existing functionality and add tests for new features or bug fixes.
+
+5. **Commit and Push:** Commit your changes with a clear and concise commit message. Reference any related issues or pull requests in your commit message. Push your branch to your forked repository on GitHub.
+
+6. **Create a Pull Request:** Open a pull request against the main branch of this repository. Provide a clear description of your changes and reference any relevant issues. Your PR will be reviewed by maintainers.
+
+7. **Review and Iterate:** Expect feedback and be prepared to make additional changes if necessary. We may request changes, and once everything looks good, your PR will be merged.
+
+## Code of Conduct
+
+Please note that we have a [Code of Conduct](docs/CODE_OF_CONDUCT) in place. We expect all contributors to adhere to it, both in interactions within this project and in interactions with other project members.
+
+## Licensing
+
+By contributing to this project, you agree that your contributions will be licensed under the project's [LICENSE](LICENSE).

CONTRIBUTING.md

@@ -2,9 +2,9 @@
 
 The <span style="color:#3EACAD">template</span> is a standardized, but flexible *project* and *documentation* structure of folders and files for sharing your data science work.
 
-Inspired by [literate programming](http://literateprogramming.com) and [Cookiecutter Data Science](https://drivendata.github.io/cookiecutter-data-science/), maintained by the [World Bank Development Data Group](https://www.worldbank.org/en/about/unit/unit-dec#2) and built as [GitHub template repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template), the <span style="color:#3EACAD">template</span> contains:
+Inspired by [literate programming](http://literateprogramming.com), maintained by the [Development Data Group](https://www.worldbank.org/en/about/unit/unit-dec/dev) and built as [GitHub template repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template), the <span style="color:#3EACAD">template</span> contains:
 
-- **README**, **CODE_OF_CONDUCT**, **CONTRIBUTING** templates
+- [**README**](README), [**CODE_OF_CONDUCT**](docs/CODE_OF_CONDUCT.md), [**CONTRIBUTING**](CONTRIBUTING.md) templates
     > README files are important and often neglected. The files should inform anyone about the first steps to use, learn and contribute to your project.
 
 - **LICENSE**

README.md

@@ -0,0 +1,48 @@
+root {
+	--sd-color-primary: #3eacad;
+	--sd-color-primary-highlight: #df6b00;
+	--sd-color-secondary: #56c3c4;
+	--sd-color-secondary-highlight: #f7951d;
+}
+
+iframe {
+	display: block;
+	border-style: none;
+	margin: 0 auto;
+}
+
+a:hover {
+	color: #56c3c4;
+}
+
+a:visited {
+	color: #310459;
+}
+
+a.headerlink {
+	color: #3eacad;
+}
+
+a.reference.external:hover {
+	color: #f7951d;
+}
+
+a.reference.internal:hover {
+	color: #3eacad;
+}
+
+a.current.reference.internal {
+	color: #56c3c4;
+}
+
+.prev-next-area a p.prev-next-title:hover {
+	color: #3eacad;
+}
+
+.prev-next-area a:visited p.prev-next-title:hover {
+	color: #56c3c4;
+}
+
+#pst-back-to-top {
+	background-color: #3eacad;
+}

_static/custom.css

@@ -1,6 +1,6 @@
 # Book settings
 title:
-author: World Bank
+author: Development Data Group
 logo: docs/images/logo.png
 only_build_toc_files: true
 
@@ -30,7 +30,7 @@ execute:
 #######################################################################################
 # Bibliography settings
 bibtex_bibfiles:
-    - docs/bibliography.bib
+  - docs/bibliography.bib
 
 #######################################################################################
 # Sphinx settings

.github/CODE_OF_CONDUCT.md renamed to docs/CODE_OF_CONDUCT.md

@@ -12,6 +12,10 @@ parts:
   - caption: Gallery
     chapters:
       - file: docs/gallery
+  - caption: Templates
+    chapters:
+      - file: docs/CODE_OF_CONDUCT
+      - file: CONTRIBUTING
   - caption: Additional Resources
     chapters:
       - url: https://datapartnership.org

docs/_config.yml

@@ -6,17 +6,15 @@ build-backend = "setuptools.build_meta"
 name = "datalab"
 dynamic = ["version"]
 description = "An Python exampe package from the World Bank Data Lab"
-readme = {file = "README.md", content-type = "text/markdown"}
-license = {file = "LICENSE"}
-keywords = ["world bank", "template", "reproducible research"]
-authors = [
-  {name="World Bank Development Data Group", email="[email protected]"},
-]
+readme = { file = "README.md", content-type = "text/markdown" }
+license = { file = "LICENSE" }
+keywords = ["template", "reproducible research"]
+authors = [{ name = "Development Data Group", email = "[email protected]" }]
 maintainers = [
-  {name="Gabriel Stefanini Vicente", email="[email protected]"},
+	{ name = "Gabriel Stefanini Vicente", email = "[email protected]" },
 ]
 classifiers = [
-    "Programming Language :: Python :: 3",
+	"Programming Language :: Python :: 3",
 	"Programming Language :: Python :: 3.7",
 	"Programming Language :: Python :: 3.8",
 	"Programming Language :: Python :: 3.9",
@@ -28,10 +26,7 @@ classifiers = [
 	"Operating System :: OS Independent",
 ]
 requires-python = ">=3.7"
-dependencies = [
-	"requests>=2.28.1",
-    "pycountry>=22.3.5",
-]
+dependencies = ["requests>=2.28.1", "pycountry>=22.3.5"]
 [project.optional-dependencies]
 notebook = ["notebook>=6.5.2"]
 
@@ -41,4 +36,4 @@ notebook = ["notebook>=6.5.2"]
 "Source" = "https://github.com/worldbank/template"
 
 [tool.setuptools.dynamic]
-version = {attr = "datalab.__version__"}
+version = { attr = "datalab.__version__" }