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
+54-54Lines changed: 54 additions & 54 deletions
Original file line number
Diff line number
Diff line change
@@ -2,11 +2,11 @@
2
2
3
3
We'd love for you to contribute to our source code and to make the Forest even better than it is today! Here are the guidelines we'd like you to follow:
4
4
5
-
-[Question or Problem?](#question)
6
-
-[Issues and Bugs](#issue)
7
-
-[Feature Requests](#feature)
8
-
-[Submission Guidelines](#submit)
9
-
-[Further Info](#info)
5
+
*[Question or Problem?](#question)
6
+
*[Issues and Bugs](#issue)
7
+
*[Feature Requests](#feature)
8
+
*[Submission Guidelines](#submit)
9
+
*[Further Info](#info)
10
10
11
11
## <aname="question"></a> Got a Question or Problem?
12
12
@@ -24,8 +24,8 @@ If you find a bug in the source code or a mistake in the documentation, you can
24
24
25
25
You can request a new feature by submitting an issue to our [Github Repository][github]. If you would like to implement a new feature then consider what kind of change it is:
26
26
27
-
-**Major Changes** that you wish to contribute to the project should be discussed first on our [Slack group][slack] so that we can better coordinate our efforts, prevent duplication of work, and help you to craft the change so that it is successfully accepted into the project.
28
-
-**Small Changes** can be crafted and submitted to the [Github Repository][github] as a Pull Request.
27
+
***Major Changes** that you wish to contribute to the project should be discussed first on our [Slack group][slack] so that we can better coordinate our efforts, prevent duplication of work, and help you to craft the change so that it is successfully accepted into the project.
28
+
***Small Changes** can be crafted and submitted to the [Github Repository][github] as a Pull Request.
29
29
30
30
## <aname="docs"></a> Want a Doc Fix?
31
31
@@ -41,12 +41,12 @@ Before you submit your issue search the archive, maybe your question was already
41
41
42
42
If your issue appears to be a bug, and hasn't been reported, open a new issue. Help us to maximize the effort we can spend fixing issues and adding new features, by not reporting duplicate issues. Providing the following information will increase the chances of your issue being dealt with quickly:
43
43
44
-
-**Overview of the Issue** - if an error is being thrown a non-minified stack trace helps
45
-
-**Motivation for or Use Case** - explain why this is a bug for you
46
-
-**Forest Version(s)** - is it a regression?
47
-
-**Reproduce the Error** - try to describe how to reproduce the error
48
-
-**Related Issues** - has a similar issue been reported before?
49
-
-**Suggest a Fix** - if you can't fix the bug yourself, perhaps you can point to what might be
44
+
***Overview of the Issue** - if an error is being thrown a non-minified stack trace helps
45
+
***Motivation for or Use Case** - explain why this is a bug for you
46
+
***Forest Version(s)** - is it a regression?
47
+
***Reproduce the Error** - try to describe how to reproduce the error
48
+
***Related Issues** - has a similar issue been reported before?
49
+
***Suggest a Fix** - if you can't fix the bug yourself, perhaps you can point to what might be
50
50
causing the problem (line of code or commit)
51
51
52
52
**If you get help, help others. Good karma rulez!**
@@ -55,45 +55,45 @@ If your issue appears to be a bug, and hasn't been reported, open a new issue. H
55
55
56
56
Before you submit your merge request consider the following guidelines:
57
57
58
-
- Make your changes in a new git branch:
58
+
* Make your changes in a new git branch:
59
59
60
-
```shell
61
-
git checkout -b my-fix-branch develop
62
-
```
60
+
```shell
61
+
git checkout -b my-fix-branch develop
62
+
```
63
63
64
-
- Create your patch, **including appropriate test cases**.
65
-
- Run the test suite and ensure that all tests pass.
66
-
- Add a line in the CHANGELOG.md under Unreleased. This will be used form generating the release notes.
67
-
- Install [pre-commit hooks](https://pre-commit.com/). The hooks runs some basic checks and update the docs. The commit will run the hooks, you can invoke the hooks manually `pre-commit run --all-files` as well.
68
-
- Commit your changes using a descriptive commit message.
64
+
* Create your patch, **including appropriate test cases**.
65
+
* Run the test suite and ensure that all tests pass.
66
+
* Add a line in the CHANGELOG.md under Unreleased. This will be used form generating the release notes.
67
+
* Install [pre-commit hooks](https://pre-commit.com/). The hooks runs some basic checks and update the docs. The commit will run the hooks, you can invoke the hooks manually `pre-commit run --all-files` as well.
68
+
* Commit your changes using a descriptive commit message.
69
69
70
-
```shell
71
-
git commit -a
72
-
```
70
+
```shell
71
+
git commit -a
72
+
```
73
73
74
74
Note: the optional commit `-a`command line option will automatically "add" and "rm" edited files.
75
75
76
-
- Build your changes locally to ensure all the tests pass:
77
-
- Push your branch to Github:
76
+
* Build your changes locally to ensure all the tests pass:
77
+
* Push your branch to Github:
78
78
79
-
```shell
80
-
git push origin my-fix-branch
81
-
```
79
+
```shell
80
+
git push origin my-fix-branch
81
+
```
82
82
83
83
In Github, send a pull request to original develop branch: f.e. `terraform-aws-vpc:develop`.
84
84
If we suggest changes, then:
85
85
86
-
- Make the required updates.
87
-
- Re-run the test suite to ensure tests are still passing.
88
-
- Commit your changes to your branch (e.g. `my-fix-branch`).
89
-
- Push the changes to your Github repository (this will update your Pull Request).
86
+
* Make the required updates.
87
+
* Re-run the test suite to ensure tests are still passing.
88
+
* Commit your changes to your branch (e.g. `my-fix-branch`).
89
+
* Push the changes to your Github repository (this will update your Pull Request).
90
90
91
91
If the PR gets too outdated we may ask you to rebase and force push to update the PR:
92
92
93
-
```shell
94
-
git rebase develop -i
95
-
git push origin my-fix-branch -f
96
-
```
93
+
```shell
94
+
git rebase develop -i
95
+
git push origin my-fix-branch -f
96
+
```
97
97
98
98
_WARNING: Squashing or reverting commits and force-pushing thereafter may remove Github comments on code that were previously made by you or others in your commits. Avoid any form of rebasing unless necessary._
99
99
@@ -104,29 +104,29 @@ That's it! Thank you for your contribution!
104
104
After your pull request is merged, you can safely delete your branch and pull the changes
105
105
from the main (upstream) repository:
106
106
107
-
- Delete the remote branch on Github either through the Github web UI or your local shell as follows:
107
+
* Delete the remote branch on Github either through the Github web UI or your local shell as follows:
108
108
109
-
```shell
110
-
git push origin --delete my-fix-branch
111
-
```
109
+
```shell
110
+
git push origin --delete my-fix-branch
111
+
```
112
112
113
-
- Check out the develop branch:
113
+
* Check out the develop branch:
114
114
115
-
```shell
116
-
git checkout develop -f
117
-
```
115
+
```shell
116
+
git checkout develop -f
117
+
```
118
118
119
-
- Delete the local branch:
119
+
* Delete the local branch:
120
120
121
-
```shell
122
-
git branch -D my-fix-branch
123
-
```
121
+
```shell
122
+
git branch -D my-fix-branch
123
+
```
124
124
125
-
- Update your develop with the latest upstream version:
125
+
* Update your develop with the latest upstream version:
0 commit comments