Skip to content

Commit

Permalink
docs(gitbook): roadmap update with status (13)
Browse files Browse the repository at this point in the history
  • Loading branch information
42atomys authored and gitbook-bot committed Apr 2, 2024
1 parent 226e28e commit f38aa72
Showing 1 changed file with 11 additions and 9 deletions.
20 changes: 11 additions & 9 deletions docs/roadmap-to-sprout-v1.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,42 +10,44 @@ description: The roadmap to grow the sprout
All objectives are get from feedback, suggestions and personal knowledge. You can discuss about the v1.0 directly [in the issue on GitHub](https://github.com/42atomys/sprout/issues/1).
{% endhint %}

### **Minimize Dependencies**
### :hourglass:**Minimize Dependencies - IN PROGRESS**

Reduce the number of external dependencies to mitigate frequent update cycles, making Sprout more stable and lightweight.

### **Enhanced Documentation**
### :hourglass:**Enhanced Documentation - IN PROGRESS**

Provide comprehensive, easy-to-understand documentation that covers all functionalities, use cases, and examples to improve the developer experience.

### **Conventional Function Naming**
### :hourglass:**Conventional Function Naming - IN PROGRESS**

Establish clear, consistent naming conventions for functions to enhance code readability and maintainability. Unlike Sprig, where function naming varies between camelCase, and snake\_case, and similar functions lack consistent prefixing, Sprout will introduce a standardised approach to function naming. This will make the library more intuitive and reduce the learning curve for new users.

### **Reduce memory fingerprint**
### :hourglass:**Reduce memory fingerprint - IN PROGRESS**

Aim to minimise memory allocations as much as possible to alleviate the burden on the garbage collector in large-scale applications. By optimising the way memory is used within the framework, we ensure that Sprout is not only efficient in its functionality but also in its resource consumption. This approach contributes to overall better performance and scalability of applications using Sprout.

### **Native Error Handling**
### :hourglass:**Native Error Handling - IN PROGRESS**

Introduce built-in error handling mechanisms for all functions to ensure that errors are managed gracefully and efficiently.

### **Advanced Error Handling Strategy**
### :hourglass:**Advanced Error Handling Strategy - IN PROGRESS**

Implement a custom error handling framework utilising channels for improved error reporting and handling on the Go side, reducing the risk of template crashes.

### **Expanded Function Set**
### :hourglass:**Expanded Function Set - IN PROGRESS**

Add a broader array of functions without imposing limitations, enabling users to accomplish more tasks directly within the framework.

### **Customisable Function Loading**
### :hourglass:**Customisable Function Loading - IN PROGRESS**

Allow users to customise which functions to load into their runtime environment, preventing unnecessary resource consumption and enhancing performance.

### **Function Aliasing**
### :white\_check\_mark: **Function Aliasing - DONE**

Enable the creation of aliases for functions outside of the library, providing flexibility and convenience in how functions are accessed and utilised.

Documentation can be found here: [function-aliases.md](function-aliases.md "mention")

## Compatibility between spring and sprout

A compatibility table between sprig v3.2.3 and sprout v1.0
Expand Down

0 comments on commit f38aa72

Please sign in to comment.