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
+11-2
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,8 @@
1
-
# Job Openings Automated Guidelines
1
+
# FinTwit-Bot Guidelines
2
2
3
3
## Code Formatting and Linting
4
4
5
-
Job Openings Automated uses [Black](https://black.readthedocs.io/en/stable/index.html) with default values for automatic code formatting, along with [ruff](https://docs.astral.sh/ruff/). We also use [NumPy-style docstrings](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_numpy.html) for documenting the code. As part of the checks on pull requests, it is checked whether the code still adheres to the code style. To ensure you don't need to worry about formatting and linting when contributing, it is recommended to set up the following:
5
+
FinTwit-Bot uses [Black](https://black.readthedocs.io/en/stable/index.html) with default values for automatic code formatting, along with [ruff](https://docs.astral.sh/ruff/). We also use [NumPy-style docstrings](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_numpy.html) for documenting the code. As part of the checks on pull requests, it is checked whether the code still adheres to the code style. To ensure you don't need to worry about formatting and linting when contributing, it is recommended to set up the following:
6
6
7
7
- Integration in VS Code:
8
8
- For [Black](https://marketplace.visualstudio.com/items?itemName=ms-python.black-formatter)
@@ -42,17 +42,21 @@ When submitting a pull request, please follow these guidelines:
42
42
To ensure a smooth and transparent merging process, we have established the following policy for merging pull requests:
43
43
44
44
1.**Review and Approval**:
45
+
45
46
- Pull requests must be reviewed and approved by at least one project maintainer.
46
47
- Reviews from other contributors are encouraged but not required.
47
48
48
49
2.**Passing Checks**:
50
+
49
51
- All pull requests must pass continuous integration (CI) checks, including tests and linters.
50
52
- Ensure there are no merge conflicts with the `main` branch.
51
53
52
54
3.**Documentation**:
55
+
53
56
- If your pull request introduces new features or changes existing functionality, update the relevant documentation.
54
57
55
58
4.**Labeling**:
59
+
56
60
- Use appropriate labels (e.g., `bug`, `enhancement`, `documentation`) to categorize the pull request.
57
61
58
62
5.**Merging**:
@@ -62,25 +66,30 @@ To ensure a smooth and transparent merging process, we have established the foll
62
66
## Branch Management Policy
63
67
64
68
1.**Branch Naming Conventions**:
69
+
65
70
- Use descriptive names for your branches to make it clear what feature or fix is being worked on.
66
71
- Common prefixes include `feature/`, `bugfix/`, `hotfix/`, and `chore/`.
0 commit comments