Version 1.0.6

CHANGELOG.md

@@ -2,6 +2,21 @@
 
 All notable changes to this project will be documented in this file.
 
+## [1.0.6] - 2024-09-05
+
+### Added
+- Expanded the **Contributing** section to include detailed guidelines on branch naming conventions, code style (autopep8, isort, flake8), testing, and PR submission.
+- Added a suggestion for running tests (`pytest`) and code formatting/linting commands (`autopep8`, `isort`, `flake8`) before submitting pull requests.
+
+### Changed
+- Improved the **Contributing** section in the documentation to provide better clarity on contribution processes and coding standards.
+- Updated the **Contributing** section to include information about the Continuous Integration (CI) pipeline and the required coding practices.
+- Removed "flags" from `index.rst` as the content was moved to the **Usage** section in version 1.0.5 but not reflected in the index.
+
+### Fixed
+- Resolved a merge conflict in the `README.md` file caused during cherry-picking of changes from the `joss-submission` branch to the `main` branch.
+
+
 ## [1.0.5] - 2024-09-04
 
 ### Added

docs/source/contributing.rst

@@ -1,13 +1,40 @@
 Contributing
 ============
 
-Contributions are welcome! Please follow these steps to contribute:
+We welcome contributions to improve LorenzCycleToolkit! Please follow these steps to contribute:
 
-1. Fork the repository.
-2. Create a new branch (`git checkout -b feature-branch`).
-3. Make your changes.
-4. Commit your changes (`git commit -m 'Add some feature'`).
-5. Push to the branch (`git push origin feature-branch`).
-6. Create a new Pull Request.
+1. **Fork the repository** and clone your fork.
+2. **Create a new branch**: 
+   - Use one of the following naming conventions:
+     - ``feature/your-feature-name`` for new features
+     - ``bugfix/your-bug-name`` for bug fixes
+     - ``hotfix/your-hotfix-name`` for urgent fixes
+   - Example: ``git checkout -b feature/new-visualization``
+3. **Make your changes** following the project's coding standards.
+4. **Test your changes**: Ensure all tests pass by running:
+   .. code-block:: bash
 
-Please ensure your code follows the project's coding standards and passes all tests before submitting a pull request.
+      pytest
+     
+5. **Format your code**: Run the following commands to ensure your code adheres to the project standards:
+   .. code-block:: bash
+
+      autopep8 --in-place --recursive .
+      isort .
+      flake8
+
+6. **Commit your changes**: 
+   - Use descriptive commit messages, e.g., ``git commit -m 'Add energy cycle visualization feature'``
+7. **Push your changes** to your fork:
+   .. code-block:: bash
+
+      git push origin feature/new-visualization
+      
+8. **Create a pull request**: Submit your PR through GitHub, following our PR template and referencing any related issues.
+
+Before submitting your pull request, please ensure:
+
+- Your code passes all tests and follows the coding standards.
+- You have added or updated documentation if necessary.
+
+Thank you for contributing!

docs/source/index.rst

@@ -17,7 +17,6 @@ Welcome to the LorenzCycleToolkit documentation! This toolkit is designed to cal
    usage
    configuration
    file_naming_convention
-   flags
    examples_and_tutorials
    results
    math