Skip to content

Commit 9202bed

Browse files
committed
Add contributing guidelines and issue templates
1 parent 65bba63 commit 9202bed

File tree

5 files changed

+400
-0
lines changed

5 files changed

+400
-0
lines changed

docs/CONTRIBUTING.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Contributing to Investing Algorithm Framework
2+
3+
Thank you for considering contributing to the Investing Algorithm Framework! We welcome contributions from the community to make this project better.
4+
5+
Before contributing, please read the [STYLE_GUIDE.md](STYLE_GUIDE.md) to understand the coding style and conventions used in this project. Also, make sure to reach out
6+
to the maintainers in the [Discussions]() or [Issues]() if you have any questions or need help. Also, if you would like to add a new feature or fix a bug, please create first an issue or start a discussion to discuss it with the maintainers.
7+
8+
## How to Contribute
9+
10+
1. **Fork the Repository**: Click the `Fork` button in the top-right corner of the repo.
11+
2. **Clone Your Fork**:
12+
13+
```bash
14+
git clone https://github.com/your-username/your-project.git
15+
cd your-project
16+
```
17+
18+
3. Set Up the Environment: Follow the steps in the README.md to set up dependencies and the local environment.
19+
4. Propose your feature or bugfix in the [issues](https://github.com/coding-kitties/investing-algorithm-framework/issues) or in a [discussion](https://github.com/coding-kitties/investing-algorithm-framework/discussions).
20+
5. Make Changes:
21+
* Work on your feature or bugfix in a separate branch.
22+
* Use a meaningful branch name like fix-issue-123 or feature-new-module.
23+
6. Run Tests: Run the tests to ensure your changes don't break anything:
24+
25+
```bash
26+
python -m unittest discover -s tests
27+
```
28+
29+
7. Run Linting and make sure your code follows the [style guide](https://github.com/coding-kitties/investing-algorithm-framework):
30+
31+
```bash
32+
flake8 investing_algorithm_framework
33+
```
34+
35+
8. Create a Pull Request inline with the [Pull Request Template]().
36+
9. Wait for the maintainers to review your PR. Make changes if requested.
37+
10. Once your PR is approved, it will be merged into the main branch.

docs/ISSUE_TEMPLATE/bug_report.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
name: Bug Report
3+
about: Report a bug in the project
4+
title: "[Bug]: Brief description"
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the Bug**
11+
A clear and concise description of what the bug is.
12+
13+
**Steps to Reproduce**
14+
Steps to reproduce the behavior:
15+
1. Go to '...'
16+
2. Run '...'
17+
3. See error
18+
19+
**Expected Behavior**
20+
What you expected to happen.
21+
22+
**Screenshots (if applicable)**
23+
If applicable, add screenshots to help explain your problem.
24+
25+
**Environment (please complete the following information):**
26+
- OS: [e.g., macOS 12.3, Windows 11]
27+
- Python version: [e.g., 3.9.1]
28+
- Package version: [e.g., 0.1.0]
29+
30+
**Additional Context**
31+
Add any other context about the problem here.
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature Request
3+
about: Suggest a new feature or improvement
4+
title: "[Feature]: Brief description"
5+
labels: enhancement
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem?**
11+
A clear and concise description of the problem. Example: "I find it difficult to ..."
12+
13+
**Describe the Solution You'd Like**
14+
What you want the feature to do.
15+
16+
**Describe Alternatives You've Considered**
17+
Any alternative solutions or features you've considered.
18+
19+
**Additional Context**
20+
Add any other context or screenshots about the feature request here.

docs/PULL_REQUEST_TEMPLATE.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Pull Request Title: [Brief Description]
2+
3+
## Description
4+
5+
A clear and concise description of the changes made. Include:
6+
- What issue or feature this PR addresses.
7+
- Why these changes are necessary.
8+
9+
Fixes #[issue-number] (if applicable).
10+
11+
## Type of Change
12+
- [ ] Bugfix
13+
- [ ] New feature
14+
- [ ] Documentation update
15+
- [ ] Refactor/optimization
16+
17+
## Checklist
18+
- [ ] Code is formatted with `black` or a similar linter.
19+
- [ ] Tests have been added or updated.
20+
- [ ] Documentation has been updated (if needed).
21+
22+
## Additional Notes
23+
Include any additional notes or context here.

0 commit comments

Comments
 (0)