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
+5-22Lines changed: 5 additions & 22 deletions
Original file line number
Diff line number
Diff line change
@@ -10,20 +10,7 @@ They can be done somewhat in isolation from other tasks and will take a couple h
10
10
Please come join us on our [Slack](https://join.slack.com/t/neuralprophet/shared_invite/zt-sgme2rw3-3dCH3YJ_wgg01IXHoYaeCg), you can message any core dev there.
11
11
12
12
## Process
13
-
In summary, follow the steps below to make your first contribution. If you want to have more details on every step, check out this [beginner's guide to contributing to a GitHub project](https://akrabat.com/the-beginners-guide-to-contributing-to-a-github-project/#to-sum-up).
14
-
15
-
1. Setup your development environment for NeuralProphet following [this tutorial](https://github.com/ourownstory/neural_prophet/edit/1166-shorten-contributing.md/CONTRIBUTING.md#dev-install)
16
-
2. Find an issue to work on by filtering on the label https://github.com/ourownstory/neural_prophet/labels/good%20first%20issue. Comment under the issue, you wish to take over to prevent multiple people working on the same issue.
17
-
3. Pull the latest changes from remote: `git pull upstream main`
18
-
4. Push changes to your fork: `git push origin main`
19
-
5. Create a new branch from main to work on: `git checkout -b BRANCH_NAME`
20
-
6. Make some changes in your local repository
21
-
7. Stage the changes: `git add -A`
22
-
8. Commit the changes: `git commit -m "DESCRIPTION OF CHANGES"`
23
-
9. Do a pull request: If you visit https://github.com/ourownstory/neural_prophet now, there should be a green button saying "Compare & pull request", click on it and describe the changes you did. Now you only need to wait for a review and respond to any feedback.
24
-
25
-
Congratulations, you just contributed your first pull request. For your next issue just follow the steps starting from number 2.
26
-
13
+
If this is your first time contributing to NeuralProphet, please read our [wiki summary](https://github.com/ourownstory/neural_prophet/wiki#contributing-process) of the steps involved.
27
14
## Dev Install
28
15
Before starting it's a good idea to first create and activate a new virtual environment:
29
16
```
@@ -62,15 +49,11 @@ We follow a set of guidelines and methodologies to ensure that code is of high q
62
49
*[Continuous Integration](https://github.com/ourownstory/neural_prophet/wiki#continous-integration): Github Actions is used to set up a CI pipeline
63
50
*[Code Style](https://github.com/ourownstory/neural_prophet/wiki#style): Deploy Black, so there is no need to worry about code style and formatting.
64
51
65
-
# Github issues and pull requests
66
-
67
-
# Github issues and pull requests
68
-
69
-
## Pull requests
52
+
## Prefixes and labels for pull requests and issues
70
53
71
54
### Prefixes for pull requests
55
+
All pull requests (PR) should have one of the following prefixes:
72
56
73
-
All pull requests should have one of the following prefixes:
74
57
*[breaking] Breaking changes, which require user action (e.g. breaking API changes)
75
58
*[major] Major features worth mentioning (e.g. uncertainty prediction)
76
59
*[minor] Minor features which are nice to know about (e.g. add sorting to labels in plots)
@@ -82,14 +65,14 @@ All pull requests should have one of the following prefixes:
82
65
Those prefixed are then used to generate the changelog and decide which version number change is necessary for a release.
83
66
84
67
### Labels for pull requests
68
+
Once your PR needs attention, please add an appropriate label:
0 commit comments