|
a |
|
b/docs/CONTRIBUTING.md |
|
|
1 |
<img src='docs/VPE.png' height="50" width="50"></img> |
|
|
2 |
# Contributing Guidelines |
|
|
3 |
|
|
|
4 |
Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional |
|
|
5 |
documentation, we greatly value feedback and contributions from our community. |
|
|
6 |
|
|
|
7 |
Please read through this document before submitting any issues or pull requests to ensure we have all the necessary |
|
|
8 |
information to effectively respond to your bug report or contribution. |
|
|
9 |
|
|
|
10 |
In addition, please review our [CodeOps](./ops/CodeOps.md) to understand our approach to coding. |
|
|
11 |
|
|
|
12 |
## Code contributions |
|
|
13 |
### Reporting Bugs/Feature Requests |
|
|
14 |
|
|
|
15 |
Please use the [GitHub issue tracker](https://github.com/VirtualPatientEngine/AIAgents4Pharma/issues) to report bugs or suggest features. |
|
|
16 |
|
|
|
17 |
When filing an issue, please check existing open, or recently closed, issues to make sure somebody else hasn't already |
|
|
18 |
reported the issue. Please try to include as much information as you can following the bug and feature templates that we provide. |
|
|
19 |
|
|
|
20 |
### Contributing via Pull Requests |
|
|
21 |
Contributions via pull requests are much appreciated. Before sending us a pull request, please review our [DevOps](./ops/DevOps.md) guide, and please ensure that: |
|
|
22 |
|
|
|
23 |
1. You are working against the latest source on the *main* branch. |
|
|
24 |
2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already. |
|
|
25 |
3. You open an issue to discuss any significant work - we would hate for your time to be wasted. |
|
|
26 |
|
|
|
27 |
### Finding contributions to work on |
|
|
28 |
Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any 'help wanted' issues is a great place to start. |
|
|
29 |
|
|
|
30 |
## Code of Conduct |
|
|
31 |
This project follows the [Apache Code of Conduct](https://www.apache.org/foundation/policies/conduct). |
|
|
32 |
|
|
|
33 |
## Security issue notifications |
|
|
34 |
If you discover a potential security issue in this project we ask that you notify Team VPE directly: mccloskey at bio dot mx. Please do **not** create a public github issue. |
|
|
35 |
|
|
|
36 |
## Attributions |
|
|
37 |
Portions adopted from https://github.com/pytorch, https://github.com/rapidsai, and https://github.com/aws-samples/ |