Merge pull request #68 from mikhailsirenko/develop

Major refactoring and update to v0.4.0

.github/workflows/docs.yml

@@ -23,7 +23,7 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-python@v4
         with:
-          python-version: '3.11'
+          python-version: '3.12.4'
 
       # ADJUST THIS: install all dependencies (including pdoc)
       - run: pip install pipreqs
@@ -52,4 +52,4 @@ jobs:
       url: ${{ steps.deployment.outputs.page_url }}
     steps:
       - id: deployment
-        uses: actions/deploy-pages@v2
+        uses: actions/deploy-pages@v2

.gitignore

@@ -77,15 +77,11 @@ target/
 
 # exclude real data from source control by default
 /data/raw
-/data/processed
 /data/interim
 /data/external
 
-# exclude figures until the paper is not on the arxiv
-/figures
-
-# exclude for now, keep later
-/features
+# exclude reports until the paper is not on the arxiv
+/reports
 
 # Mac OS-specific storage files
 .DS_Store
@@ -101,27 +97,38 @@ target/
 .idea/
 cache/
 
-# Raw country-specific experiment results
-experiments/Dominica
-experiments/Saint Lucia
+# exclude config files but keep Example.yaml
+/config/*
+!/config/Example.yaml
 
-# Internal reports
-/reports
+# exclude data_preparation from source control by default
+/data_preparation/*
+!/data_preparation/Example
 
-# Input data preparation scripts
-/scripts
+# exclude data_preparation from source control by default
+/data/generated/*
+!/data/generated/Example
 
-# Exclude Dominica-specific config
-/config/Dominica.yaml
+# exclude data but keep the Example folder or file
+/data/processed/asset_impacts/*
+!/data/processed/asset_impacts/Example
 
-# Exclude Saint-Lucia specific config
-/config/SaintLucia.yaml
+/data/processed/household_survey/*
+!/data/processed/household_survey/Example.csv
 
-# Exclude Nigeria specific config
-/config/Nigeria.yaml
+data/processed/population_impacts/*
+!/data/processed/population_impacts/Example
 
-# Exclude reports
-/reports
+# exclude drafts folder
+/drafts
+
+# exclude notebooks but keep the Example folder
+/notebooks/*
+!/notebooks/Example
+
+# exclude results and keep only the Example folder
+/results/*
+!/results/Example
 
-# Exclude experiment results
-/results
+# exlcude todo folder
+/todo

CONTRIBUTING.md

@@ -0,0 +1,93 @@
+# Contributing
+
+We welcome contributions to the Unbreakable project! Whether you're fixing bugs, adding new features, improving documentation, or providing feedback, your help is appreciated.
+
+## How to Contribute
+
+### 1. Fork the Repository
+
+- Click the **Fork** button at the top right of the [repository page](https://github.com/mikhailsirenko/unbreakable) to create your own copy of the project.
+
+### 2. Clone Your Fork
+
+- Clone your forked repository to your local machine:
+
+  ```bash
+  git clone https://github.com/your-username/unbreakable.git
+  cd unbreakable
+  ```
+
+### 3. Create a New Branch
+
+- Create a new branch for your feature or bug fix:
+
+  ```bash
+  git checkout -b my-feature-branch
+  ```
+
+### 4. Make Changes
+
+- Implement your changes in the codebase.
+- Follow the existing code style and conventions.
+- Include comments and docstrings where appropriate.
+- Update or add documentation as needed.
+
+### 5. Commit Changes
+
+- Stage your changes and commit with a descriptive message:
+
+  ```bash
+  git add .
+  git commit -m "Description of your changes"
+  ```
+
+### 6. Push to Your Fork
+
+- Push your branch to your forked repository on GitHub:
+
+  ```bash
+  git push origin my-feature-branch
+  ```
+
+### 7. Submit a Pull Request
+
+- Go to the original repository and click on **Pull Requests**, then **New Pull Request**.
+- Select your branch from the **compare** dropdown.
+- Provide a clear and descriptive title and description for your pull request.
+- Submit the pull request for review.
+
+## Reporting Issues
+
+- If you encounter a bug or have a feature request, please open an [issue](https://github.com/mikhailsirenko/unbreakable/issues) on GitHub.
+- Provide detailed information about the issue, including steps to reproduce it if applicable.
+
+## Code Style Guidelines
+
+- Follow the existing coding style and structure.
+- Use meaningful variable and function names.
+- Keep functions and classes focused and concise.
+- Write tests for new features or bug fixes when possible.
+
+## Testing
+
+- Ensure that all existing tests pass before submitting a pull request.
+- Add new tests to cover your changes.
+- Run tests using:
+
+  ```bash
+  python -m unittest discover tests
+  ```
+
+## Documentation
+
+- Update the `README.md` or relevant documentation files if your changes affect them.
+- Ensure that code is well-documented with comments and docstrings.
+
+## Communication
+
+- Feel free to contact the project maintainers for guidance.
+- Be respectful and considerate in all interactions.
+
+## License
+
+By contributing to Unbreakable, you agree that your contributions will be licensed under Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0).