Skip to content

Commit

Permalink
DOCS: Weeks 6, 7 and 8 Blog posts
Browse files Browse the repository at this point in the history
  • Loading branch information
WassCodeur committed Aug 13, 2024
1 parent 5223349 commit b8cc3e0
Show file tree
Hide file tree
Showing 6 changed files with 176 additions and 3 deletions.
3 changes: 1 addition & 2 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -215,8 +215,7 @@ Doing the release

* Publish a release on PyPI::

python setup.py sdist
python setup.py bdist_wheel
python -m build
twine upload dist/*


Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/source/posts/2024/2024-07-31-release-announcement.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
FURY 0.11.0 Released
===================
====================

.. post:: July 31 2024
:author: skoudoro
Expand Down
92 changes: 92 additions & 0 deletions docs/source/posts/2024/2024-08-06-week6-wachiou-bouraima.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
WEEK 6: Code reviews, relining and crush challenges
===================================================

.. post:: August 6, 2024
:author: Wachiou BOURAIMA
:tags: google
:category: gsoc

Hello everyone,
As my Google Summer of Code (GSoC) 2024 journey progresses, week6 has brought me a series of technical challenges and accomplishments. My main focus has been on code reviews, rebasing and commits squasing, with a few notable lessons learned along the way.


Code Reviews and Merging ``Pull Requests``
-------------------------------------------

One of the main activities this week was receiving and addressing feedback on several of my pull requests. Notably, my mentor `Serge Koudoro <https://github.com/skoudoro/>`_, reviewed and merged the PRs related to the ``warn_on_args_to_kwargs`` decorator and the application of the ``warn_on_args_to_kwargs`` decorator across various modules. The merging of these PRs was a critical step in ensuring that our codebase adhered to the project's evolving standards for clarity and maintainability.


Rebasing and Squashing: Overcoming Challenges
---------------------------------------------

- I performed rebasing and squashing to integrate the latest changes and consolidate commits. This process was challenging due to several conflicts that arose. Resolving these conflicts required a deep dive into Git’s functionality, including:

- **Conflict Resolution:** Manually resolving merge conflicts that affected several files.

- **Understanding Git Operations:** Gained hands-on experience with rebasing and squashing, which improved my grasp of version control workflows.

- **Commit Consolidation:** multiple commits into a single commit to streamline the commit history and enhance readability.

.. code-block:: bash
# Rebase the branch onto the upstream/master branch
git rebase upstream/master -xtheirs
# Squash the last "n" commits into a single commit
git rebase -i HEAD~n
# Continue the rebase process after resolving conflicts
git rebase --continue
git rebase --abort
# Amend the last commit with new changes
git commit --amend
# Push the changes to the remote repository
git push origin branch_name --force
- Merged PRs:

- `warn_on_args_to_kwargs`: https://github.com/fury-gl/fury/pull/888
- `actors`: https://github.com/fury-gl/fury/pull/898
- `animation`: https://github.com/fury-gl/fury/pull/899
- `data`: https://github.com/fury-gl/fury/pull/900
- `shares`: https://github.com/fury-gl/fury/pull/901
- `ui`: https://github.com/fury-gl/fury/pull/902


Technical Insights and Lessons Learned
---------------------------------------

- **Version Control Mastery:** Through the rebasing and squashing process, I gained a deeper understanding of Git’s capabilities and the importance of maintaining a clean commit history.


Acknowledgements
----------------

I want to extend my thanks to my mentor `Serge Koudoro <https://github.com/skoudoro/>`_, for his detailed feedback and guidance. Your support has been crucial in refining my work. I also appreciate the constructive comments from my peers: `Iñigo Tellaetxe Elorriaga <https://github.com/itellaetxe>`_, `Robin Roy <https://github.com/robinroy03>`_, `Kaustav Deka <https://github.com/deka27>`_, which have been instrumental in improving the quality of my contributions.


Did I get stuck anywhere?
--------------------------

While the rebasing and squashing process presented challenges, I was able to overcome them with the help of My mentor and online resources and documentation.

- `How to Squash Commits in Git <https://www.git-tower.com/learn/git/faq/git-squash>`_
- `Git: Theirs vs Ours <https://dev.to/tariqabughofa/git-theirs-vs-ours-3i7h>`_
- `How to squash and rebase in git <https://youtu.be/AWayLpQHJeE?si=I-fRM0H3icvm9ua8>`_

The experience has enhanced my Git proficiency and prepared me for future code management tasks.


What's next ?
-------------

In the week 7, I plan to:

1. Review Adjustments: I'll be reviewing the feedback provided by my mentor `Serge Koudoro <https://github.com/skoudoro/>`_, on the latest changes to ensure that everything meets ``FURY``'s coding standards.
2. Finalizing Lazy Loading: Once the reviews are completed and approved, my mentor `Serge Koudoro <https://github.com/skoudoro/>`_, will merge the PR related to the lazy loading implementation. This will mark a significant milestone in optimizing the FURY codebase.
3. Sphinx Warning Fixes: I will start addressing Sphinx warnings related to typos in the blog posts to improve the documentation quality.
36 changes: 36 additions & 0 deletions docs/source/posts/2024/2024-08-06-week7-wachiou-bouraima.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
WEEK 7: Fixing Sphinx Warnings in Blog Posts
============================================

.. post:: August 6, 2024
:author: Wachiou BOURAIMA
:tags: google
:category: gsoc

Hello everyone,
Welcome back to another update on my GSoC 2024 journey. This week, my focus was primarily on addressing Sphinx warnings caused by typos in blog posts.


Addressing Sphinx Warnings
--------------------------

This week, I dedicated my time to resolving Sphinx warnings that were popping up due to typos in various blog posts. Out of the 100 warnings that were initially present, I was able to fix 98 of them. This process involved carefully reviewing the documentation, identifying the sources of the warnings, and making the necessary corrections.

Here’s a snapshot of some of the warnings I addressed:

.. image:: /_static/images/gsdoc-some-sphinx-warnings-addressed_Wachiou.jpg
:alt: a snapshot of some of the warnings


Did I get stuck anywhere ?
--------------------------

While most of the warnings were straightforward to fix, a few required a bit more time and attention to detail. In particular, some typos were present in code snippets, which required careful examination to ensure that the corrections did not introduce any errors.

What's Next ?
--------------

In the upcoming week,

- I will begin addressing Sphinx warnings related to typos in the documentation for certain modules.
- I will also focus on improving the overall readability and clarity of the documentation to enhance the user experience.
- Refining Lazy Loading Implementation according to the feedback received from my mentor.
46 changes: 46 additions & 0 deletions docs/source/posts/2024/2024-08-12-week8-wachiou-bouraima.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
WEEK 8: Refining Lazy Loading Implementation and Simplifying Imports in FURY
=============================================================================

.. post:: August 12, 2024
:author: Wachiou BOURAIMA
:tags: google
:category: gsoc

Hello everyone,
Welcome back to another update on my Google Summer of Code (GSoC) 2024 journey! This week, my mentor and I focused on refining the lazy loading feature and optimizing import statements within FURY’s ``examples modules``.


Reviewing and Refining Lazy Loading
------------------------------------

This week was dedicated to a thorough review of the lazy loading implementation I introduced in the previous weeks. My mentor provided invaluable feedback, and together we identified areas where the implementation could be improved.


I addressed several issues, including
--------------------------------------

- **Error Fixes**: During the review, we identified some edge cases that were not handled correctly by the lazy loading mechanism. I corrected these errors to ensure the feature works seamlessly across the FURY codebase.

- **Import Simplification**: One significant change was simplifying how FURY is imported in example modules. Previously, the import statements were more complex, like ``from fury import ....`` To align with the lazy loading principles and reduce unnecessary overhead, I updated these statements to a more straightforward ``import fury`` This change ensures that only the necessary components are loaded when they are actually needed, improving performance.


Rebasing and Squashing
-----------------------

After making these adjustments, I proceeded with rebasing and squashing my commits. This process was essential to maintain a clean and organized commit history. Despite the challenges, I managed to resolve all conflicts, and my mentor approved the changes. The pull request was successfully merged, marking another milestone in the project.


Did I get stuck anywhere?
--------------------------

No, I did not encounter any major roadblocks this week. The tasks were challenging but manageable, and I was able to address them effectively with the guidance of my mentor.

What's Next?
------------

In the upcoming week,

- I will continue addressing Sphinx warnings related.
- start working to improve de FURY website.

Thank you for following along, and stay tuned for more updates as I continue to make progress on this project!

0 comments on commit b8cc3e0

Please sign in to comment.