-
Notifications
You must be signed in to change notification settings - Fork 13
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add documentation for creating a new field #10
Merged
ferblape
merged 16 commits into
PopulateTools:master
from
Quentinchampenois:fix/add_documentation
Nov 4, 2022
Merged
Add documentation for creating a new field #10
ferblape
merged 16 commits into
PopulateTools:master
from
Quentinchampenois:fix/add_documentation
Nov 4, 2022
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ferblape
approved these changes
Nov 4, 2022
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Cool, nice tutorial.
Although Rubocop is a bit noisy with the comments, it's ok to introduce it.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Add a documentation file in directory
docs
. It contains a guide to create an example fieldminimum_age
. This field is just a checkbox that must be checked by user to register.I added a lot of comments in files to simplify the reading of the guide. Also, it will help to create a skeleton task for generating most of the code for creating a new field in the module
Tasks
Related to #2