Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Update docs to avoid installing grunt-cli #29

Merged
merged 2 commits into from
Sep 20, 2020
Merged

Update docs to avoid installing grunt-cli #29

merged 2 commits into from
Sep 20, 2020

Conversation

nekonenene
Copy link

@nekonenene nekonenene commented Sep 19, 2020 •
edited
Loading

Proposed changes

Developers don't need to install grunt-cli because we already installed into node_modules via npm install. Now, I replaced commands in docs using npm instead of grunt.

Types of changes

  • Bug fix (non-breaking change which fixes an issue).
  • New feature (non-breaking change which adds functionality).
  • Breaking change (fix or feature that would cause existing functionality to change).

Checklist:

  • I have read the CONTRIBUTING document.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

Smankusors
Smankusors approved these changes Sep 20, 2020
View reviewed changes
Copy link
Member

@Smankusors Smankusors left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this seems better IMO, what do you think? @DanielRuf

DanielRuf
DanielRuf suggested changes Sep 20, 2020
View reviewed changes
CONTRIBUTING.md Outdated
@@ -164,7 +164,7 @@ If you want to help us translate the documentation into other languages, please
- [Example Jasmine Tests](https://github.com/materializecss/materialize/tree/master/tests/spec)
- [Travis CI](https://travis-ci.org/materializecss/materialize)

Before you start, make sure you install grunt and all its dependencies. To verify you have all the correct dependencies you can run `grunt travis` and it will run the tests. If you get an errors and have not made any changes, it means you have not installed the proper dependencies.
After `npm install`, you can run `npm test` and it will run the tests. If you get an errors and have not made any changes, it means you have not installed the proper dependencies.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

an errors => any errors

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! Fixed.

@DanielRuf
Copy link

Thanks, this is much better than before.

@DanielRuf DanielRuf merged commit 4889641 into materializecss:v1-dev Sep 20, 2020
@DanielRuf
Copy link

@nekonenene you should have received an invitation for the materializecss org and to the members team of it.

You can see and accept it at https://github.com/materializecss

@DanielRuf DanielRuf added the documentation Improvements or additions to documentation label Sep 20, 2020
@nekonenene
Copy link
Author

@DanielRuf
Thanks! I joined. 💪

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Smankusors Smankusors Smankusors approved these changes

@DanielRuf DanielRuf DanielRuf approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@nekonenene @DanielRuf @Smankusors