Skip to content

Commit e08a2f9

Browse files
committed
Merge branch 'v2-dev' into color-variables
# Conflicts: # sass/components/_sidenav.scss
2 parents 7a8ae81 + 360f549 commit e08a2f9

File tree

151 files changed

+5208
-5274
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

151 files changed

+5208
-5274
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
## Checklist:
1515
<!-- Go over all the following points, and put an `x` in all the boxes that apply. If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
1616

17-
- [ ] I have read the **[CONTRIBUTING document](https://github.com/materializecss/materialize/blob/master/CONTRIBUTING.md)**.
17+
- [ ] I have read the **[CONTRIBUTING document](https://github.com/materializecss/materialize/blob/main/CONTRIBUTING.md)**.
1818
- [ ] My change requires a change to the documentation.
1919
- [ ] I have updated the documentation accordingly.
2020
- [ ] I have added tests to cover my changes.

.github/workflows/docs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ name: Docs
22
on:
33
push:
44
branches:
5-
- v1-dev
5+
- main
66

77
jobs:
88
docs:

CHANGELOG.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Changelog
2-
All notable changes to this project will be documented in this file. For changes made before this fork, please refer to [HISTORY.md](https://github.com/materializecss/materialize/blob/v1-dev/HISTORY.md).
2+
All notable changes to this project will be documented in this file. For changes made before this fork, please refer to [HISTORY.md](https://github.com/materializecss/materialize/blob/main/HISTORY.md).
33

44
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
55
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
@@ -8,7 +8,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
88

99
### Added
1010

11-
- Nightly builds of the latest code available through github actions ([Easy link for the latest build](https://nightly.link/materializecss/materialize/workflows/nightly/v1-dev/build)) ([58d18003](https://github.com/materializecss/materialize/commit/58d180036374f2b38a244e5e96c33838ce185220))
11+
- Nightly builds of the latest code available through github actions ([Easy link for the latest build](https://nightly.link/materializecss/materialize/workflows/nightly/main/build)) ([58d18003](https://github.com/materializecss/materialize/commit/58d180036374f2b38a244e5e96c33838ce185220))
1212
- Added support for text input suffix icons ([3e516e5b](https://github.com/materializecss/materialize/commit/3e516e5b322e4f8c7299cc37504389d0ddbb1ed6))
1313
- Added dragTargetWidth option ([6f4b2a15](https://github.com/materializecss/materialize/commit/6f4b2a15fc9f21a91ce95a1baffe60cfb15619df))
1414
- Added ability to change tooltip animate opacity ([8fce193f](https://github.com/materializecss/materialize/commit/8fce193fa94fe6d5a04630e732623c84fc803c3d))
@@ -43,7 +43,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
4343
- Fixed XSS vulnerabilities ([3aae4cc9](https://github.com/materializecss/materialize/commit/3aae4cc9bb2b58c337bf25d2f04f129a2a0fa78f))
4444

4545
#### Many other small changes have been made:
46-
https://github.com/Dogfalo/materialize/compare/v1-dev...materializecss:v1-dev
46+
https://github.com/Dogfalo/materialize/compare/v1-dev...materializecss:1.1.0-alpha
4747

4848
#### Contributors
4949
Many thanks to all the contributors that made this release possible.

CONTRIBUTING.md

Lines changed: 22 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,26 @@
1-
Contributing
2-
------------
1+
# Contributing
32

43
Looking to contribute something to Materialize? **Here's how you can help.**
54

6-
### Table of contents:
5+
## Table of contents:
6+
- [Table of contents:](#table-of-contents)
77
- [Introduction](#introduction)
8-
- [Communication channels](#communication-channels)
8+
- [Communication channels](#communication-channels)
99
- [Using the issue tracker](#using-the-issue-tracker)
1010
- [Issues and labels](#issues-and-labels)
1111
- [Bug reports](#bug-reports)
12+
- [Guidelines for bug reports:](#guidelines-for-bug-reports)
1213
- [Feature Requests](#feature-requests)
1314
- [Code Examples](#code-examples)
1415
- [Pull Requests](#pull-requests)
1516
- [Documentation](#documentation)
1617
- [Submitting Your Pull Request](#submitting-your-pull-request)
1718
- [Translations](#translations)
18-
- [Jasmine Testing Guide](#jasmine-testing-guide)
19+
- [Jasmine Testing Guide:](#jasmine-testing-guide)
20+
- [Starting Out](#starting-out)
21+
- [Writing Tests](#writing-tests)
22+
- [Useful Jasmine Tips](#useful-jasmine-tips)
23+
- [License](#license)
1924

2025
## Introduction
2126
Please take a moment to review this document in order to make the contribution
@@ -31,8 +36,8 @@ patches and features.
3136
Before you now get lost in the repository, here are a few starting points for you to check out. You might find that others have had similar questions or that your question rather belongs in one place than another.
3237

3338
* Chat: https://gitter.im/materializecss/materialize
34-
* Website: http://materializecss.com
35-
* Twitter: https://twitter.com/materializecss
39+
* Website: https://materializecss.github.io/materialize
40+
* Github discussions: https://github.com/materializecss/materialize/discussions
3641

3742
## Using the issue tracker
3843

@@ -56,12 +61,11 @@ Our bug tracker utilizes several labels to help organize and identify issues. He
5661

5762
- `component:*` - Each component has been provided a label. Add the labels for any component the issue is triggered by.
5863
- `confirmed` - Issues that have been confirmed with a reduced test case and identify a bug in Materialize.
59-
- `css` - Issues stemming from our compiled CSS or source Sass files.
64+
- `css/sass` - Issues stemming from our compiled CSS or source Sass files.
6065
- `js` - Issues stemming from our compiled or source JavaScript files.
61-
- `docs` - Issues for improving or updating our documentation.
62-
- `help-wanted` - Issues we need or would love help from the community to resolve.
66+
- `documentation` - Issues for improving or updating our documentation.
67+
- `help wanted` - Issues we need or would love help from the community to resolve.
6368
- `meta` - Issues with the project itself or our GitHub repository.
64-
- `on-hold` Issues or pull that should be worked on, but for any reason it won't be worked on/accepted as a PR anytime soon.
6569

6670
For a complete look at our labels, see the [project labels page](https://github.com/materializecss/materialize/labels).
6771

@@ -75,7 +79,7 @@ Good bug reports are extremely helpful! Unclear issues with little explanations
7579

7680
1. **Use the GitHub issue search** - check if the issue has already been reported.
7781

78-
2. **Check if the issue has been fixed** - try to reproduce it using the latest `master` or development branch in the repository.
82+
2. **Check if the issue has been fixed** - try to reproduce it using the latest commited branch in the repository. The [`main`](https://github.com/materializecss/materialize/tree/main) branch is stable, other branches are used for development.
7983

8084
3. **Isolate the problem** &mdash; create a [reduced test case](https://css-tricks.com/reduced-test-cases/) using **our** [Codepen template](#code-examples).
8185

@@ -88,9 +92,9 @@ We like feature requests but make sure that it can be seen within the goals of t
8892
### Code Examples
8993

9094
- Issues without a [Codepen](#code-examples) (where applicable) will be closed or ignored.
91-
- Use this [Codepen](http://codepen.io/Dogfalo/pen/xbzPQV) to illustrate your problem.
95+
- Use this [Codepen](https://codepen.io/pen/?template=MRNObV) to illustrate your problem.
9296

93-
## Pull requests
97+
## Pull Requests
9498

9599
Good pull requests - patches, improvements, new features - are a fantastic help. Thanks for taking the time to contribute.
96100

@@ -104,7 +108,7 @@ and/or [`/materialize/js/`](https://github.com/materializecss/materialize/tree/m
104108
### Documentation
105109

106110
When contributing to Materialize's documentation, you should edit the documentation source files in
107-
[the `/materialize/jade/page-contents/` directory of the `master` branch](https://github.com/materializecss/materialize/tree/master/jade).
111+
[the `/materialize/pug/page-contents/` directory of the `master` branch](https://github.com/materializecss/materialize/tree/master/pug).
108112
**Do not edit the `gh-pages` branch.** That branch is generated from the documentation source files and is managed separately by the Materialize maintainers.
109113

110114
### Submitting Your Pull Request
@@ -136,7 +140,7 @@ Adhering to the following process is the best way to get your work included in t
136140
git checkout -b <topic-branch-name>
137141
```
138142

139-
4. Commit your changes in logical chunks with messages written in english. Please adhere to these [git commit message guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) or your code is unlikely be merged into the main project.
143+
4. Commit your changes in logical chunks with messages written in English. Please adhere to these [git commit message guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) and use [conventional commit format](https://github.com/conventional-changelog/commitlint/#what-is-commitlint) in your commit messages (or use `npm run commit` to make your life easier). Failing to do this makes your commits unlikely to be merged into the main project.
140144

141145
5. Locally merge (or rebase) the upstream development branch into your topic branch:
142146

@@ -150,19 +154,18 @@ Adhering to the following process is the best way to get your work included in t
150154
git push origin <topic-branch-name>
151155
```
152156

153-
7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/) with a clear title and description against the `master` branch. Reference any open issue in the description so it is automatically linked. Try and keep your commit history clean and concise. Once you submit your pull request, [Travis CI](https://travis-ci.org/materializecss/materialize) will automatically run your tests and will show a checkmark to show that all the tests have passed. Once this is done, we’ll review your tests and code and make comments if there are issues or things we think could be improved. Then once everything looks good we’ll merge the code in!
157+
7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/) with a clear title and description against the current development branch, usually `vX.X.X-dev`. Reference any open issue in the description so it is automatically linked. Try and keep your commit history clean and concise. Once you submit your pull request, Github Actions will automatically run your tests and will show a checkmark to show that all the tests have passed. Once this is done, we’ll review your tests and code and make comments if there are issues or things we think could be improved. Then once everything looks good we’ll merge the code in!
154158

155159
## Translations
156160

157-
If you want to help us translate the documentation into other languages, please send us an email at [email protected] telling us which language team you want to join. We use [Transifex](https://www.transifex.com) as our localization platform and we will send you an invite there.
161+
If you want to help us translate the documentation into other languages, you can visit the [translation discussion here](https://github.com/materializecss/materialize/discussions/182).
158162

159163
## Jasmine Testing Guide:
160164

161165
**References:**
162166
- [Jasmine Documentation](http://jasmine.github.io/2.0/introduction.html)
163167
- [Grunt Jasmine Plugin](https://github.com/gruntjs/grunt-contrib-jasmine)
164168
- [Example Jasmine Tests](https://github.com/materializecss/materialize/tree/master/tests/spec)
165-
- [Travis CI](https://travis-ci.org/materializecss/materialize)
166169

167170
After `npm install`, you can run `npm test` and it will run the tests. If you get any errors and have not made any changes, it means you have not installed the proper dependencies.
168171

0 commit comments

Comments
 (0)