You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,9 +1,9 @@
1
1
# Contributors Guide
2
2
3
-
Welcome to the **EVEREST™ Tutorials** repository!
4
-
We appreciate your interest in contributing to this project.
3
+
Welcome to the **EVEREST™ Tutorials** repository!
4
+
We appreciate your interest in contributing to this project.
5
5
6
-
We expect all contributors to adhere to the [Code of Conduct](CODE_OF_CONDUCT.md).
6
+
We expect all contributors to adhere to the [Code of Conduct](CODE_OF_CONDUCT.md).
7
7
Be respectful and inclusive in all interactions.
8
8
9
9
Below are the guidelines to help you contribute effectively.
@@ -21,8 +21,8 @@ Below are the guidelines to help you contribute effectively.
21
21
22
22
## Introduction
23
23
24
-
The EVEREST Tutorials repository is focused on providing reproducible tutorials for EVEREST.
25
-
This is a documentation-based repository with examples and configuration files that focus on practical usage.
24
+
The EVEREST Tutorials repository is focused on providing reproducible tutorials for EVEREST.
25
+
This is a documentation-based repository with examples and configuration files that focus on practical usage.
26
26
Contributors are welcome to improve the tutorials, fix bugs, and suggest enhancements to the documentation.
27
27
28
28
@@ -68,7 +68,7 @@ We enforce this linting all commit and pull request messages using the [commitli
68
68
69
69
#### Commit Message Format
70
70
71
-
Each commit message consists of a `header`, a `body` and a `footer`.
71
+
Each commit message consists of a `header`, a `body` and a `footer`.
72
72
The header has a special format that includes a `type`, a `scope` and a `subject`:
73
73
74
74
```
@@ -83,7 +83,7 @@ The `header` and the `subject` are mandatory and the rest are optional.
83
83
If there is a `body` you need to add a blank line between the header and the body.
84
84
If there is `footer` you need to add a blank line between the body and the footer.
85
85
86
-
The footer can contain a `close` or `fixes` keyword to link to the issue and close it when the pull request is merged.
86
+
The footer can contain a `close` or `fixes` keyword to link to the issue and close it when the pull request is merged.
87
87
This behavior is described in [Linking a pull request to an issue using a keyword](https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword).
88
88
89
89
The accepted types follow the [Angular convention](https://github.com/conventional-changelog/commitlint/tree/master/@commitlint/config-conventional#type-enum) and can be:
@@ -119,7 +119,7 @@ chore(main): release 0.4.1
119
119
120
120
### Pull Request Guidelines
121
121
122
-
The format of the pull request message is the same as the commit message.
122
+
The format of the pull request message is the same as the commit message.
123
123
Ensure your pull request is based on the latest main branch.
124
124
Follow the repository's commit message format.
125
125
Provide a clear description of the changes in the pull request.
0 commit comments