This repository has been archived by the owner on May 5, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
/
CONTRIBUTING
52 lines (35 loc) · 2.94 KB
/
CONTRIBUTING
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
# Contributing guidelines
## To suggest a new feature or dataset for inclusion
- [Search the existing issues](https://github.com/opentargets/features/issues) to see if the feature has already been suggested. Make sure you look at closed issues too.
- If no similar issue exist, [create a new issue](https://github.com/opentargets/features/issues/new). Please be as descriptive as possible. In particular, it should describe what the value for a Open Targets Platform user should be.
- Add the `QUESTION` label to the issue.
- If you are suggesting a new data source, please also add the label `DATASOURCE` to the issue
Once you have done this, please await review and some consensus building from the Open Targets team or directly on github from other users.
## Is My Thing a Feature (or Zenhub epic)?
Here are a few rough heuristics.
A feature is anything for which *any* of the following applies:
- would be part of release notes
- a blog post could be written about after its release
- requires multiple parties/repos participating to complete (backend,webapp,ux,api,...)
- needs significant effort or changes the platform in a significant way (ex. something that would take 10 person-weeks to implement, introduce or redesign a system component, or introduces API changes)
- impacts the UX or operation of the platform substantially so that users would need guidance on how to take advantage of it
It is unlikely a feature if it is:
- adding/fixing a test
- refactoring code
- performance improvements, which are only visible to users as faster API operations, or faster control loops
- adding error messages or events
These examples should probably be tracked directly in the repo where the code change is happening.
## It's a good suggestion. How do I physically put it in the roadmap?
*The piece below is intended for the OpenTargets dev team or any code contributors.*
Thanks for wanting to add a feature to Open Targets! You will be responsible for guiding
your feature through completion, and asking the right people for approvals.
Large features typically go through three stages: [Prototype, Beta, and Stable]
Each stage requires various approvals from various teams (UX, infrastructure, data-pipeline, webapp).
Features may require several releases to reach stable.
Use the following process when an issue or suggestion has already been discussed within the opentargets team or on the issue tracker and some consensus has been reached that that the problem you are trying to solve is worth solving at this time.
To put a new feature on the roadmap:
1. create a new issue in this repository
2. add the `FEATURE` label
3. reference previous issues or suggestion if applicable. This will allow the person who originated the suggestion to keep track of progress.
4. Then head to the [roadmap](https://github.com/orgs/opentargets/projects/3) and move it to the backlog (at least).
5. We will review it at our monthly planning meeting and decide if/when it can be scheduled.