@@ -11,8 +11,10 @@ Our project is hosted on GitHub. If you're reading this guide on our website and
11
11
12
12
### 1. Familiarize Yourself with the Project
13
13
14
- Start by understanding the scope and objectives of our project:
14
+ Start by understanding the scope and objectives of our project:
15
+
15
16
- Review the [ documentation] ( https://github.com/inab/FAIRsoft_indicators/tree/main/docs/indicators ) where the indicators are described.
17
+
16
18
- Understand the existing indicators, their importance, and how they are used.
17
19
18
20
### 2. Explore Existing Issues
@@ -23,21 +25,27 @@ Look through the project's [issue tracker](https://github.com/inab/FAIRsoft_indi
23
25
24
26
### 3. Submit a New Issue
25
27
26
- If you identify a potential improvement or have a new indicator in mind:
27
- - Submit a [ new issue] ( https://github.com/inab/FAIRsoft_indicators/issues/new ) detailing your idea.
28
+ If you identify a potential improvement or have a new indicator in mind:
29
+ - Submit a [ new issue] ( https://github.com/inab/FAIRsoft_indicators/issues/new ) detailing your idea.
30
+
28
31
- Provide comprehensive details including the purpose of the indicator, its measurement methodology, and any relevant literature or examples.
29
32
30
33
### 4. Participate in Discussions
31
34
32
- Engage actively in the [ discussions section] ( https://github.com/inab/FAIRsoft_indicators/discussions ) :
33
- - Share your insights, provide feedback, and help refine proposals.
35
+ Engage actively in the [ discussions section] ( https://github.com/inab/FAIRsoft_indicators/discussions ) :
36
+
37
+ - Share your insights, provide feedback, and help refine proposals.
38
+
34
39
- Discussions are great platforms for brainstorming and collaborating on new ideas.
35
40
36
41
### 5. Propose Changes via Pull Requests
37
42
38
- If you're familiar with GitHub and Git:
39
- - Fork the repository, create a new branch for your changes, and develop your enhancements.
40
- - Submit a pull request with a clear description of your changes and reference any related issue(s).
43
+ If you're familiar with GitHub and Git:
44
+
45
+ - Fork the repository, create a new branch for your changes, and develop your enhancements.
46
+
47
+ - Submit a pull request with a clear description of your changes and reference any related issue(s).
48
+
41
49
- Follow any coding standards and guidelines provided in the repository.
42
50
43
51
### 6. Review Contributions
@@ -46,9 +54,12 @@ Participate in the review process by providing constructive feedback on other co
46
54
47
55
### 7. Spread the Word
48
56
49
- Help expand our community:
50
- - Share the project within your networks.
51
- - Present the indicators at workshops, seminars, and conferences.
57
+ Help expand our community:
58
+
59
+ - Share the project within your networks.
60
+
61
+ - Present the indicators at workshops, seminars, and conferences.
62
+
52
63
- Encourage your peers to contribute.
53
64
54
65
## Stay Connected
0 commit comments