search

FormidableLabs / freactal

Clean and robust state management for React and React-like libs.
MIT License
1.65k stars 47 forks source link

Enhancement: props documentation in initialstate and compute #84

Closed GHEMID-Mohamed closed 6 years ago

GHEMID-Mohamed commented 6 years ago

While i'm working with freactal I noticed that Props can't be passed in computed and there is no documentation on it. Also I wanted to pass props in initialState but I didn't knew how till my manager checked the source code. So I added some lines to the doc in order to clarify things for future users :)

The maintainers of this repo require that all pull request submitters adhere to the following:

The maintainers of this repository require you to select the semantic version type that the changes in this pull request represent. Please select one of the following:

maintainerd[bot] commented 6 years ago

maintainerd logging is enabled for this repository.

All actions related to rules and their enforcement will be logged here as a permanent record.

Click to view log...

- `2017-11-10T15:15:40.820Z:9188660`: The pull request was created - `2017-11-10T15:17:56.906Z:9188660`: @HamadaBrest checked `I have read and will comply with the [contribution guidelines](https://github.com/FormidableLabs/freactal/blob/master/CONTRIBUTE.md).`. - `2017-11-10T15:17:59.356Z:9188660`: @HamadaBrest checked `I have read and will comply with the [code of conduct](https://github.com/FormidableLabs/freactal/blob/master/CONTRIBUTE.md).`. - `2017-11-10T15:18:00.940Z:9188660`: @HamadaBrest checked `All related documentation has been updated to reflect the changes made. _(required)_`. - `2017-11-10T15:18:02.402Z:9188660`: @HamadaBrest checked `My commit messages are cleaned up and ready to merge. _(required)_`. - `2017-11-10T15:18:15.376Z:9188660`: @HamadaBrest selected `documentation only` as the semantic version.

ryan-roemer commented 6 years ago

@HamadaBrest -- @divmain can correct me if I'm wrong, but I think maintainerd CI wants you to rewrite your commit message to meet: https://github.com/FormidableLabs/freactal/blob/master/.maintainerd#L25-L28 along these lines: https://github.com/FormidableLabs/freactal/blob/master/CONTRIBUTE.md#commit-message-structure

In particular, I think it needs the to start with TYPE: message. You can see previous community commits at: https://github.com/FormidableLabs/freactal/commits/master

ryan-roemer commented 6 years ago

LGTM. Closing and reopening to kick maintainerd.