Skip to content

Commit aeea2ff

Browse files
committed
contributing fix items
1 parent 8df3a58 commit aeea2ff

File tree

1 file changed

+22
-11
lines changed

1 file changed

+22
-11
lines changed

CONTRIBUTING.md

Lines changed: 22 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,10 @@ Our project is hosted on GitHub. If you're reading this guide on our website and
1111

1212
### 1. Familiarize Yourself with the Project
1313

14-
Start by understanding the scope and objectives of our project:
14+
Start by understanding the scope and objectives of our project:
15+
1516
- Review the [documentation](https://github.com/inab/FAIRsoft_indicators/tree/main/docs/indicators) where the indicators are described.
17+
1618
- Understand the existing indicators, their importance, and how they are used.
1719

1820
### 2. Explore Existing Issues
@@ -23,21 +25,27 @@ Look through the project's [issue tracker](https://github.com/inab/FAIRsoft_indi
2325

2426
### 3. Submit a New Issue
2527

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+
2831
- Provide comprehensive details including the purpose of the indicator, its measurement methodology, and any relevant literature or examples.
2932

3033
### 4. Participate in Discussions
3134

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+
3439
- Discussions are great platforms for brainstorming and collaborating on new ideas.
3540

3641
### 5. Propose Changes via Pull Requests
3742

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+
4149
- Follow any coding standards and guidelines provided in the repository.
4250

4351
### 6. Review Contributions
@@ -46,9 +54,12 @@ Participate in the review process by providing constructive feedback on other co
4654

4755
### 7. Spread the Word
4856

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+
5263
- Encourage your peers to contribute.
5364

5465
## Stay Connected

0 commit comments

Comments
 (0)