Line length Open
For bug fixes, add new test cases that demonstrate the fixed behavior. For new features, include comprehensive test coverage to maintain a high level of code quality. Run the test suite locally to confirm that all tests pass successfully.
- Read upRead up
- Exclude checks
MD013 - Line length
Tags: line_length
Aliases: line-length
Parameters: linelength, ignorecodeblocks, codeblocks, tables (number; default 80, boolean; default false, boolean; default true, boolean; default true)
This rule is triggered when there are lines that are longer than the configured line length (default: 80 characters). To fix this, split the line up into multiple lines.
This rule has an exception where there is no whitespace beyond the configured line length. This allows you to still include items such as long URLs without being forced to break them in the middle.
You also have the option to exclude this rule for code blocks. To
do this, set the ignore_code_blocks
parameter to true. To exclude this rule
for tables set the tables
parameters to false. Setting the parameter
code_blocks
to false to exclude the rule for code blocks is deprecated and
will be removed in a future release.
Code blocks are included in this rule by default since it is often a requirement for document readability, and tentatively compatible with code rules. Still, some languages do not lend themselves to short lines.
Ordered list item prefix Open
5. #### Testing
- Read upRead up
- Exclude checks
MD029 - Ordered list item prefix
Tags: ol
Aliases: ol-prefix
Parameters: style (:one
, :ordered
; default :one
)
This rule is triggered on ordered lists that do not either start with '1.' or do not have a prefix that increases in numerical order (depending on the configured style, which defaults to 'one').
Example valid list if the style is configured as 'one':
1. Do this.
1. Do that.
1. Done.
Example valid list if the style is configured as 'ordered':
1. Do this.
2. Do that.
3. Done.
Line length Open
Go to the original repository and create a Pull Request (PR). Fill in the PR template with relevant information, including a clear description of your changes and the problem they address. A maintainer will review your PR, and there may be some feedback or adjustments required before it gets merged.
- Read upRead up
- Exclude checks
MD013 - Line length
Tags: line_length
Aliases: line-length
Parameters: linelength, ignorecodeblocks, codeblocks, tables (number; default 80, boolean; default false, boolean; default true, boolean; default true)
This rule is triggered when there are lines that are longer than the configured line length (default: 80 characters). To fix this, split the line up into multiple lines.
This rule has an exception where there is no whitespace beyond the configured line length. This allows you to still include items such as long URLs without being forced to break them in the middle.
You also have the option to exclude this rule for code blocks. To
do this, set the ignore_code_blocks
parameter to true. To exclude this rule
for tables set the tables
parameters to false. Setting the parameter
code_blocks
to false to exclude the rule for code blocks is deprecated and
will be removed in a future release.
Code blocks are included in this rule by default since it is often a requirement for document readability, and tentatively compatible with code rules. Still, some languages do not lend themselves to short lines.
Trailing punctuation in header Open
#### Important Note: The `master` branch is for beta releases, and the `main` branch is for stable releases. When changes are pushed to the `master` branch, a beta version will be released, whereas pushing changes to the `main` branch will trigger a release for the next stable version.
- Read upRead up
- Exclude checks
MD026 - Trailing punctuation in header
Tags: headers
Aliases: no-trailing-punctuation
Parameters: punctuation (string; default ".,;:!?")
This rule is triggered on any header that has a punctuation character as the last character in the line:
# This is a header.
To fix this, remove any trailing punctuation:
# This is a header
Note: The punctuation parameter can be used to specify what characters class
as punctuation at the end of the header. For example, you can set it to
'.,;:!'
to allow headers with question marks in them, such as might be used
in an FAQ.
Ordered list item prefix Open
4. #### Make Changes
- Read upRead up
- Exclude checks
MD029 - Ordered list item prefix
Tags: ol
Aliases: ol-prefix
Parameters: style (:one
, :ordered
; default :one
)
This rule is triggered on ordered lists that do not either start with '1.' or do not have a prefix that increases in numerical order (depending on the configured style, which defaults to 'one').
Example valid list if the style is configured as 'one':
1. Do this.
1. Do that.
1. Done.
Example valid list if the style is configured as 'ordered':
1. Do this.
2. Do that.
3. Done.
Line length Open
#### Important Note: The `master` branch is for beta releases, and the `main` branch is for stable releases. When changes are pushed to the `master` branch, a beta version will be released, whereas pushing changes to the `main` branch will trigger a release for the next stable version.
- Read upRead up
- Exclude checks
MD013 - Line length
Tags: line_length
Aliases: line-length
Parameters: linelength, ignorecodeblocks, codeblocks, tables (number; default 80, boolean; default false, boolean; default true, boolean; default true)
This rule is triggered when there are lines that are longer than the configured line length (default: 80 characters). To fix this, split the line up into multiple lines.
This rule has an exception where there is no whitespace beyond the configured line length. This allows you to still include items such as long URLs without being forced to break them in the middle.
You also have the option to exclude this rule for code blocks. To
do this, set the ignore_code_blocks
parameter to true. To exclude this rule
for tables set the tables
parameters to false. Setting the parameter
code_blocks
to false to exclude the rule for code blocks is deprecated and
will be removed in a future release.
Code blocks are included in this rule by default since it is often a requirement for document readability, and tentatively compatible with code rules. Still, some languages do not lend themselves to short lines.
Line length Open
Welcome to the react-big-schedule project! We're thrilled that you're interested in contributing to our open-source scheduling component for React. By contributing to this project, you can help make it even better and support the broader developer community.
- Read upRead up
- Exclude checks
MD013 - Line length
Tags: line_length
Aliases: line-length
Parameters: linelength, ignorecodeblocks, codeblocks, tables (number; default 80, boolean; default false, boolean; default true, boolean; default true)
This rule is triggered when there are lines that are longer than the configured line length (default: 80 characters). To fix this, split the line up into multiple lines.
This rule has an exception where there is no whitespace beyond the configured line length. This allows you to still include items such as long URLs without being forced to break them in the middle.
You also have the option to exclude this rule for code blocks. To
do this, set the ignore_code_blocks
parameter to true. To exclude this rule
for tables set the tables
parameters to false. Setting the parameter
code_blocks
to false to exclude the rule for code blocks is deprecated and
will be removed in a future release.
Code blocks are included in this rule by default since it is often a requirement for document readability, and tentatively compatible with code rules. Still, some languages do not lend themselves to short lines.
Line length Open
Begin by forking the main repository to your GitHub account. This will create a personal copy of the project that you can work on.
- Read upRead up
- Exclude checks
MD013 - Line length
Tags: line_length
Aliases: line-length
Parameters: linelength, ignorecodeblocks, codeblocks, tables (number; default 80, boolean; default false, boolean; default true, boolean; default true)
This rule is triggered when there are lines that are longer than the configured line length (default: 80 characters). To fix this, split the line up into multiple lines.
This rule has an exception where there is no whitespace beyond the configured line length. This allows you to still include items such as long URLs without being forced to break them in the middle.
You also have the option to exclude this rule for code blocks. To
do this, set the ignore_code_blocks
parameter to true. To exclude this rule
for tables set the tables
parameters to false. Setting the parameter
code_blocks
to false to exclude the rule for code blocks is deprecated and
will be removed in a future release.
Code blocks are included in this rule by default since it is often a requirement for document readability, and tentatively compatible with code rules. Still, some languages do not lend themselves to short lines.
Ordered list item prefix Open
9. #### Celebrate
- Read upRead up
- Exclude checks
MD029 - Ordered list item prefix
Tags: ol
Aliases: ol-prefix
Parameters: style (:one
, :ordered
; default :one
)
This rule is triggered on ordered lists that do not either start with '1.' or do not have a prefix that increases in numerical order (depending on the configured style, which defaults to 'one').
Example valid list if the style is configured as 'one':
1. Do this.
1. Do that.
1. Done.
Example valid list if the style is configured as 'ordered':
1. Do this.
2. Do that.
3. Done.
Line length Open
Commit your changes with a descriptive and concise commit message. Once you are satisfied with your changes, push the branch to your forked repository.
- Read upRead up
- Exclude checks
MD013 - Line length
Tags: line_length
Aliases: line-length
Parameters: linelength, ignorecodeblocks, codeblocks, tables (number; default 80, boolean; default false, boolean; default true, boolean; default true)
This rule is triggered when there are lines that are longer than the configured line length (default: 80 characters). To fix this, split the line up into multiple lines.
This rule has an exception where there is no whitespace beyond the configured line length. This allows you to still include items such as long URLs without being forced to break them in the middle.
You also have the option to exclude this rule for code blocks. To
do this, set the ignore_code_blocks
parameter to true. To exclude this rule
for tables set the tables
parameters to false. Setting the parameter
code_blocks
to false to exclude the rule for code blocks is deprecated and
will be removed in a future release.
Code blocks are included in this rule by default since it is often a requirement for document readability, and tentatively compatible with code rules. Still, some languages do not lend themselves to short lines.
Header levels should only increment by one level at a time Open
### Code of Conduct
- Read upRead up
- Exclude checks
MD001 - Header levels should only increment by one level at a time
Tags: headers
Aliases: header-increment
This rule is triggered when you skip header levels in a markdown document, for example:
# Header 1
### Header 3
We skipped out a 2nd level header in this document
When using multiple header levels, nested headers should increase by only one level at a time:
# Header 1
## Header 2
### Header 3
#### Header 4
## Another Header 2
### Another Header 3
Trailing punctuation in header Open
#### Happy coding!
- Read upRead up
- Exclude checks
MD026 - Trailing punctuation in header
Tags: headers
Aliases: no-trailing-punctuation
Parameters: punctuation (string; default ".,;:!?")
This rule is triggered on any header that has a punctuation character as the last character in the line:
# This is a header.
To fix this, remove any trailing punctuation:
# This is a header
Note: The punctuation parameter can be used to specify what characters class
as punctuation at the end of the header. For example, you can set it to
'.,;:!'
to allow headers with question marks in them, such as might be used
in an FAQ.
Ordered list item prefix Open
7. #### Create a Pull Request
- Read upRead up
- Exclude checks
MD029 - Ordered list item prefix
Tags: ol
Aliases: ol-prefix
Parameters: style (:one
, :ordered
; default :one
)
This rule is triggered on ordered lists that do not either start with '1.' or do not have a prefix that increases in numerical order (depending on the configured style, which defaults to 'one').
Example valid list if the style is configured as 'one':
1. Do this.
1. Do that.
1. Done.
Example valid list if the style is configured as 'ordered':
1. Do this.
2. Do that.
3. Done.
Line length Open
Before you start contributing, please take a moment to read our Code of Conduct. We expect all contributors to adhere to these guidelines to ensure a positive and inclusive community for everyone. You can find our Code of Conduct [here](https://github.com/react-scheduler/react-big-schedule/blob/master/CODE_OF_CONDUCT.md).
- Read upRead up
- Exclude checks
MD013 - Line length
Tags: line_length
Aliases: line-length
Parameters: linelength, ignorecodeblocks, codeblocks, tables (number; default 80, boolean; default false, boolean; default true, boolean; default true)
This rule is triggered when there are lines that are longer than the configured line length (default: 80 characters). To fix this, split the line up into multiple lines.
This rule has an exception where there is no whitespace beyond the configured line length. This allows you to still include items such as long URLs without being forced to break them in the middle.
You also have the option to exclude this rule for code blocks. To
do this, set the ignore_code_blocks
parameter to true. To exclude this rule
for tables set the tables
parameters to false. Setting the parameter
code_blocks
to false to exclude the rule for code blocks is deprecated and
will be removed in a future release.
Code blocks are included in this rule by default since it is often a requirement for document readability, and tentatively compatible with code rules. Still, some languages do not lend themselves to short lines.
Line length Open
We value contributions in various forms – from reporting issues and suggesting improvements to submitting feature requests and providing code changes. To get started with your contributions, follow these steps:
- Read upRead up
- Exclude checks
MD013 - Line length
Tags: line_length
Aliases: line-length
Parameters: linelength, ignorecodeblocks, codeblocks, tables (number; default 80, boolean; default false, boolean; default true, boolean; default true)
This rule is triggered when there are lines that are longer than the configured line length (default: 80 characters). To fix this, split the line up into multiple lines.
This rule has an exception where there is no whitespace beyond the configured line length. This allows you to still include items such as long URLs without being forced to break them in the middle.
You also have the option to exclude this rule for code blocks. To
do this, set the ignore_code_blocks
parameter to true. To exclude this rule
for tables set the tables
parameters to false. Setting the parameter
code_blocks
to false to exclude the rule for code blocks is deprecated and
will be removed in a future release.
Code blocks are included in this rule by default since it is often a requirement for document readability, and tentatively compatible with code rules. Still, some languages do not lend themselves to short lines.
Line length Open
Create a new branch for your specific contribution. Please use a descriptive and meaningful name for your branch, such as `fix/issue-123` or `feature/new-feature`.
- Read upRead up
- Exclude checks
MD013 - Line length
Tags: line_length
Aliases: line-length
Parameters: linelength, ignorecodeblocks, codeblocks, tables (number; default 80, boolean; default false, boolean; default true, boolean; default true)
This rule is triggered when there are lines that are longer than the configured line length (default: 80 characters). To fix this, split the line up into multiple lines.
This rule has an exception where there is no whitespace beyond the configured line length. This allows you to still include items such as long URLs without being forced to break them in the middle.
You also have the option to exclude this rule for code blocks. To
do this, set the ignore_code_blocks
parameter to true. To exclude this rule
for tables set the tables
parameters to false. Setting the parameter
code_blocks
to false to exclude the rule for code blocks is deprecated and
will be removed in a future release.
Code blocks are included in this rule by default since it is often a requirement for document readability, and tentatively compatible with code rules. Still, some languages do not lend themselves to short lines.
Line length Open
Thank you for taking the time to contribute to react-big-schedule! Your passion and effort are what make open-source communities thrive. We value your contributions and look forward to seeing you grow with the project.
- Read upRead up
- Exclude checks
MD013 - Line length
Tags: line_length
Aliases: line-length
Parameters: linelength, ignorecodeblocks, codeblocks, tables (number; default 80, boolean; default false, boolean; default true, boolean; default true)
This rule is triggered when there are lines that are longer than the configured line length (default: 80 characters). To fix this, split the line up into multiple lines.
This rule has an exception where there is no whitespace beyond the configured line length. This allows you to still include items such as long URLs without being forced to break them in the middle.
You also have the option to exclude this rule for code blocks. To
do this, set the ignore_code_blocks
parameter to true. To exclude this rule
for tables set the tables
parameters to false. Setting the parameter
code_blocks
to false to exclude the rule for code blocks is deprecated and
will be removed in a future release.
Code blocks are included in this rule by default since it is often a requirement for document readability, and tentatively compatible with code rules. Still, some languages do not lend themselves to short lines.
Ordered list item prefix Open
2. #### Set up the Development Environment
- Read upRead up
- Exclude checks
MD029 - Ordered list item prefix
Tags: ol
Aliases: ol-prefix
Parameters: style (:one
, :ordered
; default :one
)
This rule is triggered on ordered lists that do not either start with '1.' or do not have a prefix that increases in numerical order (depending on the configured style, which defaults to 'one').
Example valid list if the style is configured as 'one':
1. Do this.
1. Do that.
1. Done.
Example valid list if the style is configured as 'ordered':
1. Do this.
2. Do that.
3. Done.
Ordered list item prefix Open
3. #### Create a Branch
- Read upRead up
- Exclude checks
MD029 - Ordered list item prefix
Tags: ol
Aliases: ol-prefix
Parameters: style (:one
, :ordered
; default :one
)
This rule is triggered on ordered lists that do not either start with '1.' or do not have a prefix that increases in numerical order (depending on the configured style, which defaults to 'one').
Example valid list if the style is configured as 'one':
1. Do this.
1. Do that.
1. Done.
Example valid list if the style is configured as 'ordered':
1. Do this.
2. Do that.
3. Done.
Line length Open
- Follow the JavaScript Standard Style, as it helps maintain a consistent and readable codebase.
- Read upRead up
- Exclude checks
MD013 - Line length
Tags: line_length
Aliases: line-length
Parameters: linelength, ignorecodeblocks, codeblocks, tables (number; default 80, boolean; default false, boolean; default true, boolean; default true)
This rule is triggered when there are lines that are longer than the configured line length (default: 80 characters). To fix this, split the line up into multiple lines.
This rule has an exception where there is no whitespace beyond the configured line length. This allows you to still include items such as long URLs without being forced to break them in the middle.
You also have the option to exclude this rule for code blocks. To
do this, set the ignore_code_blocks
parameter to true. To exclude this rule
for tables set the tables
parameters to false. Setting the parameter
code_blocks
to false to exclude the rule for code blocks is deprecated and
will be removed in a future release.
Code blocks are included in this rule by default since it is often a requirement for document readability, and tentatively compatible with code rules. Still, some languages do not lend themselves to short lines.
Line length Open
Congratulations on your contribution! Your efforts help improve this project for everyone. Once your PR gets merged, your contribution will be acknowledged in the project's release notes and contributors' list.
- Read upRead up
- Exclude checks
MD013 - Line length
Tags: line_length
Aliases: line-length
Parameters: linelength, ignorecodeblocks, codeblocks, tables (number; default 80, boolean; default false, boolean; default true, boolean; default true)
This rule is triggered when there are lines that are longer than the configured line length (default: 80 characters). To fix this, split the line up into multiple lines.
This rule has an exception where there is no whitespace beyond the configured line length. This allows you to still include items such as long URLs without being forced to break them in the middle.
You also have the option to exclude this rule for code blocks. To
do this, set the ignore_code_blocks
parameter to true. To exclude this rule
for tables set the tables
parameters to false. Setting the parameter
code_blocks
to false to exclude the rule for code blocks is deprecated and
will be removed in a future release.
Code blocks are included in this rule by default since it is often a requirement for document readability, and tentatively compatible with code rules. Still, some languages do not lend themselves to short lines.
Ordered list item prefix Open
8. #### Collaboration and Feedback
- Read upRead up
- Exclude checks
MD029 - Ordered list item prefix
Tags: ol
Aliases: ol-prefix
Parameters: style (:one
, :ordered
; default :one
)
This rule is triggered on ordered lists that do not either start with '1.' or do not have a prefix that increases in numerical order (depending on the configured style, which defaults to 'one').
Example valid list if the style is configured as 'one':
1. Do this.
1. Do that.
1. Done.
Example valid list if the style is configured as 'ordered':
1. Do this.
2. Do that.
3. Done.
Ordered list item prefix Open
6. #### Commit and Push
- Read upRead up
- Exclude checks
MD029 - Ordered list item prefix
Tags: ol
Aliases: ol-prefix
Parameters: style (:one
, :ordered
; default :one
)
This rule is triggered on ordered lists that do not either start with '1.' or do not have a prefix that increases in numerical order (depending on the configured style, which defaults to 'one').
Example valid list if the style is configured as 'one':
1. Do this.
1. Do that.
1. Done.
Example valid list if the style is configured as 'ordered':
1. Do this.
2. Do that.
3. Done.
Line length Open
If you're new to the project, it's a good idea to familiarize yourself with the [README.md](https://github.com/react-scheduler/react-big-schedule/blob/master/README.md) file, which provides an overview of the project and its features. Also, explore existing issues and pull requests to understand the ongoing work and discussions.
- Read upRead up
- Exclude checks
MD013 - Line length
Tags: line_length
Aliases: line-length
Parameters: linelength, ignorecodeblocks, codeblocks, tables (number; default 80, boolean; default false, boolean; default true, boolean; default true)
This rule is triggered when there are lines that are longer than the configured line length (default: 80 characters). To fix this, split the line up into multiple lines.
This rule has an exception where there is no whitespace beyond the configured line length. This allows you to still include items such as long URLs without being forced to break them in the middle.
You also have the option to exclude this rule for code blocks. To
do this, set the ignore_code_blocks
parameter to true. To exclude this rule
for tables set the tables
parameters to false. Setting the parameter
code_blocks
to false to exclude the rule for code blocks is deprecated and
will be removed in a future release.
Code blocks are included in this rule by default since it is often a requirement for document readability, and tentatively compatible with code rules. Still, some languages do not lend themselves to short lines.
Line length Open
Clone the forked repository to your local machine and set up the development environment using the instructions provided in the [README.md](https://github.com/react-scheduler/react-big-schedule/blob/master/README.md) file.
- Read upRead up
- Exclude checks
MD013 - Line length
Tags: line_length
Aliases: line-length
Parameters: linelength, ignorecodeblocks, codeblocks, tables (number; default 80, boolean; default false, boolean; default true, boolean; default true)
This rule is triggered when there are lines that are longer than the configured line length (default: 80 characters). To fix this, split the line up into multiple lines.
This rule has an exception where there is no whitespace beyond the configured line length. This allows you to still include items such as long URLs without being forced to break them in the middle.
You also have the option to exclude this rule for code blocks. To
do this, set the ignore_code_blocks
parameter to true. To exclude this rule
for tables set the tables
parameters to false. Setting the parameter
code_blocks
to false to exclude the rule for code blocks is deprecated and
will be removed in a future release.
Code blocks are included in this rule by default since it is often a requirement for document readability, and tentatively compatible with code rules. Still, some languages do not lend themselves to short lines.
Line length Open
Now comes the coding part! Make the necessary changes to the codebase following the coding guidelines outlined below:
- Read upRead up
- Exclude checks
MD013 - Line length
Tags: line_length
Aliases: line-length
Parameters: linelength, ignorecodeblocks, codeblocks, tables (number; default 80, boolean; default false, boolean; default true, boolean; default true)
This rule is triggered when there are lines that are longer than the configured line length (default: 80 characters). To fix this, split the line up into multiple lines.
This rule has an exception where there is no whitespace beyond the configured line length. This allows you to still include items such as long URLs without being forced to break them in the middle.
You also have the option to exclude this rule for code blocks. To
do this, set the ignore_code_blocks
parameter to true. To exclude this rule
for tables set the tables
parameters to false. Setting the parameter
code_blocks
to false to exclude the rule for code blocks is deprecated and
will be removed in a future release.
Code blocks are included in this rule by default since it is often a requirement for document readability, and tentatively compatible with code rules. Still, some languages do not lend themselves to short lines.
Line length Open
Our maintainers and community members will review your contributions and provide feedback. Be open to suggestions and actively participate in discussions to improve your work.
- Read upRead up
- Exclude checks
MD013 - Line length
Tags: line_length
Aliases: line-length
Parameters: linelength, ignorecodeblocks, codeblocks, tables (number; default 80, boolean; default false, boolean; default true, boolean; default true)
This rule is triggered when there are lines that are longer than the configured line length (default: 80 characters). To fix this, split the line up into multiple lines.
This rule has an exception where there is no whitespace beyond the configured line length. This allows you to still include items such as long URLs without being forced to break them in the middle.
You also have the option to exclude this rule for code blocks. To
do this, set the ignore_code_blocks
parameter to true. To exclude this rule
for tables set the tables
parameters to false. Setting the parameter
code_blocks
to false to exclude the rule for code blocks is deprecated and
will be removed in a future release.
Code blocks are included in this rule by default since it is often a requirement for document readability, and tentatively compatible with code rules. Still, some languages do not lend themselves to short lines.
Line length Open
If you encounter a bug, have a feature request, or need assistance with the library, please open an issue on the GitHub repository. Use the issue template to provide necessary details to help us understand the problem better.
- Read upRead up
- Exclude checks
MD013 - Line length
Tags: line_length
Aliases: line-length
Parameters: linelength, ignorecodeblocks, codeblocks, tables (number; default 80, boolean; default false, boolean; default true, boolean; default true)
This rule is triggered when there are lines that are longer than the configured line length (default: 80 characters). To fix this, split the line up into multiple lines.
This rule has an exception where there is no whitespace beyond the configured line length. This allows you to still include items such as long URLs without being forced to break them in the middle.
You also have the option to exclude this rule for code blocks. To
do this, set the ignore_code_blocks
parameter to true. To exclude this rule
for tables set the tables
parameters to false. Setting the parameter
code_blocks
to false to exclude the rule for code blocks is deprecated and
will be removed in a future release.
Code blocks are included in this rule by default since it is often a requirement for document readability, and tentatively compatible with code rules. Still, some languages do not lend themselves to short lines.