Skip to content

Commit 42fe952

Browse files
committed
Update contributing
1 parent cf8fc2b commit 42fe952

File tree

1 file changed

+12
-44
lines changed

1 file changed

+12
-44
lines changed

CONTRIBUTING.md

Lines changed: 12 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,19 @@
22

33
## Contribute to the value investing bot
44

5-
Feel like our bot is missing a feature? We welcome your pull requests!
5+
Feel like the framework is missing a feature or can be fixed? We welcome your pull requests!
66

77
Few pointers for contributions:
88

9-
- Create your PR against the `develop` branch, not `master`.
9+
- Create your branch against the `develop` branch, not `master`.
1010
- New features need to contain unit tests and must be PEP8 conformant (max-line-length = 100).
1111
- Creating a feature, must be done on a branch with prefix `feature_`.
1212
- Making a hotfix, must be done on a branch with prefix `hotfix_`.
1313

14-
If you are unsure, discuss the feature on our [Slack](https://join.slack.com/t/investingbots/shared_invite/enQtODgwNTg3MzA2MjYyLTdiZjczZDRlNWJjNDdmYThiMGE0MzFhOTg4Y2E0NzQ2OTgxYjA1NzU3ZWJiY2JhOTE1ZGJlZGFiNDU3OTAzMDg)
14+
If you are unsure, discuss the feature or hotfix on our [Slack](https://inv-algo-framework.slack.com)
1515
or in a [issue](https://github.com/investingbots/value-investing-bot/issues) before a PR.
1616

17-
## Getting started
18-
19-
## Before sending the PR:
17+
## Rules
2018

2119
### 1. Run unit tests
2220

@@ -46,55 +44,22 @@ pytest tests/test_<file_name>.py::test_<method_name>
4644
#### Run Flake8
4745

4846
```bash
49-
flake8 bot
47+
flake8 investing_algorithm_framework
5048
```
5149

52-
We receive a lot of code that fails the `flake8` checks.
53-
To help with that, we encourage you to install the git pre-commit
54-
hook that will warn you when you try to commit code that fails these checks.
55-
Guide for installing them is [here](http://flake8.pycqa.org/en/latest/user/using-hooks.html).
56-
5750
### 3. Test if all type-hints are correct
5851

5952
#### Run mypy
6053

6154
``` bash
62-
mypy bot
55+
mypy investing_algorithm_framework
6356
```
6457

65-
## (Core)-Committer Guide
66-
67-
### Process: Pull Requests
68-
69-
How to prioritize pull requests, from most to least important:
70-
71-
1. Fixes for broken tests. Broken means broken on any supported platform or Python version.
72-
1. Extra tests to cover corner cases.
73-
1. Minor edits to docs.
74-
1. Bug fixes.
75-
1. Major edits to docs.
76-
1. Features.
77-
78-
Ensure that each pull request meets all requirements in the Contributing document.
79-
80-
### Process: Issues
81-
82-
If an issue is a bug that needs an urgent fix, mark it for the next patch release.
83-
Then either fix it or mark as please-help.
84-
85-
For other issues: encourage friendly discussion, moderate debate, offer your thoughts.
86-
8758
### Process: Your own code changes
8859

8960
All code changes, regardless of who does them, need to be reviewed and merged by someone else.
9061
This rule applies to all the core committers.
9162

92-
Exceptions:
93-
94-
- Minor corrections and fixes to pull requests submitted by others.
95-
- While making a formal release, the release manager can make necessary, appropriate changes.
96-
- Small documentation changes that reinforce existing subject matter. Most commonly being, but not limited to spelling and grammar corrections.
97-
9863
### Responsibilities
9964

10065
- Ensure cross-platform compatibility for every change that's accepted. Windows, Mac & Linux.
@@ -107,11 +72,14 @@ Exceptions:
10772

10873
Contributors may be given commit privileges. Preference will be given to those with:
10974

110-
1. Past contributions to value investing btot and other related open-source projects. Contributions to value investing bot include both code (both accepted and pending) and friendly participation in the issue tracker and Pull request reviews. Quantity and quality are considered.
75+
1. Past contributions to value investing algorithm framework and other related open-source projects.
76+
Contributions to value for the framework include both code (both accepted and pending) and friendly participation in the issue tracker and Pull request reviews. Quantity and quality are considered.
11177
1. A coding style that the other core committers find simple, minimal, and clean.
11278
1. Access to resources for cross-platform development and testing.
11379
1. Time to devote to the project regularly.
11480

115-
Being a Committer does not grant write permission on `develop` or `master` for security reasons (Users trust the value investing bot with their Exchange API keys).
81+
Being a Committer does not grant write permission on `develop` or `master` for security reasons (Users trust the investing algorithm framework with their financial secrets).
82+
83+
### Help
11684

117-
After being Committer for some time, a Committer may be named Core Committer and given full repository access.
85+
If you want help, or not sure on how to become a committer for the project, feel free to sent an email to: investing.algorithm.framework@gmail.com

0 commit comments

Comments
 (0)