Skip to content

Commit

Permalink
Cleaned up and resolved some conflicts
Browse files Browse the repository at this point in the history
  • Loading branch information
dmatekenya committed Nov 1, 2024
1 parent 72b8c34 commit 6c33371
Show file tree
Hide file tree
Showing 5 changed files with 7 additions and 40 deletions.
4 changes: 2 additions & 2 deletions docs/_toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ parts:
- file: notebooks/bibliography.ipynb
- caption: Recommended Workflows
chapters:
- file: docs/good-practices
- file: docs/general-guide
- file: docs/folders-and-naming
- file: docs/git-workflows
- file: docs/notebook-workflows
- caption: Gallery
chapters:
- file: docs/gallery
Expand Down
14 changes: 1 addition & 13 deletions docs/folders-and-naming.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,16 +22,4 @@ We recognize that this approach may create some duplication and additional effor

## Programming Environments
- **Python virtual environments.** We recommend using ```.venv``` for virtual environments. This allows for automatic detection by tools and editors like VS Code, simplifies setup, and keeps the folder hidden in most operating systems, reducing clutter. It also promotes consistency across projects, making it easier for others to understand and navigate your setup. because this keeps the folder tree clean among other advantages.
- **Environment file for secrets and credentials**. In the project folder, you will find a file ```.env.example```, rename that file to ```.env```. This is what you will to keep API keys and other secrets. Again, refer to [this part](https://worldbank.github.io/template/README.html) of the documentation for details.












- **Environment file for secrets and credentials**. In the project folder, you will find a file ```.env.example```, rename that file to ```.env```. This is what you will to keep API keys and other secrets. Again, refer to [this part](https://worldbank.github.io/template/README.html) of the documentation for details.
12 changes: 3 additions & 9 deletions docs/git-workflows.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,15 @@
# Guidelines for Git and GitHub Workflows
This section provides essential guidelines for using Git and GitHub effectively, ensuring a structured and collaborative workflow for all team members in a project. By following these practices—such as consistently ignoring the "data" folder to protect sensitive information, avoiding direct pushes to the main branch, creating descriptive branch names, and submitting pull requests once work on a branch is complete—we can maintain a clean, organized codebase and promote efficient collaboration. These guidelines help uphold version control best practices, streamline teamwork, and reduce the potential for errors in project repositories.


## Branch Names and Other General Practices
- **Branch names**. After joining the project and cloning the repository, create a concise, descriptive branch name for your work and ensure you switch to that branch before beginning any work on your machine.
- **Update branches**. Avoid creating new update branches; instead, push your changes and resolve any conflicts directly. For instance, if bots in the repository modify your code (e.g., adjusting indentations), simply pull these changes before pushing your own updates.
- **Pull requests (PR)**. When you believe your changes are final, create a pull request and assign the project lead as the reviewer.

## Folders and Files to Ignore
As all data science repos in the Data Lab use this template, the project repo will come with ```.ignore``` file prepopulated with most files and folders which need to be ignored. However, once you join the project and create your own branch. You will have to make sure that the following folders are being ignored.
- Data folder

- Data folder
- Virtual environments (```.venv```)
- Environment (```.env```)
Feel free to add any other files (e.g., system files specific to your OS) to the ```.gitignore```






Feel free to add any other files (e.g., system files specific to your OS) to the ```.gitignore```
11 changes: 0 additions & 11 deletions docs/good-practices.md

This file was deleted.

6 changes: 1 addition & 5 deletions docs/notebooks-workflows.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,4 @@ This section provides best practices for structuring analytical notebooks to enh

- **Structure**. In all the Data Lab projects, please follow [this analytics structure](https://github.com/worldbank/sudan-poverty-monitoring/blob/main/docs/2-analytics.md).
- **Editing _toc.yml**
- **Removing/hiding cell blocks** All notebooks will be rendered in Jupyter Book. To enhance readability, ensure code cells are hidden or removed using cell tags. In some cases, you may use the hide-input cell tag.




- **Removing/hiding cell blocks** All notebooks will be rendered in Jupyter Book. To enhance readability, ensure code cells are hidden or removed using cell tags. In some cases, you may use the hide-input cell tag.

0 comments on commit 6c33371

Please sign in to comment.