You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Welcome to the Rafiki community! Whether you're a seasoned developer or just getting started with open source, there are many ways to contribute to the Rafiki project. This guide will help you find your place in our vibrant ecosystem.
8
8
9
-
- Begin a <LinkOuthref="https://github.com/interledger/rafiki/discussions">new discussion or contribute to existing discussions</LinkOut> in the Rafiki GitHub repo.
10
-
- Join the <LinkOuthref="https://interledger.slack.com">`interledger.slack.com`</LinkOut> workspace and ask any questions you have in the `#rafiki` channel.
11
-
- Try [running the system locally](/integration/playground/overview) and ask any questions you have in the #rafiki Slack channel.
9
+
## 🚀 Get started
12
10
13
-
For more details about spec contributions and development, visit <LinkOuthref="https://github.com/interledger/rafiki/blob/main/.github/contributing.md">`contributing.md`</LinkOut>.
11
+
### New to Rafiki?
14
12
15
-
## Coding
13
+
-**Explore the project**: Browse the <LinkOuthref="https://github.com/interledger/rafiki">Rafiki repository</LinkOut> to understand the codebase structure and recent activity.
14
+
15
+
-**Join our community**:
16
+
17
+
- Connect with us on <LinkOuthref="https://communityinviter.com/apps/interledger/interledger-working-groups-slack">`interledger.slack.com`</LinkOut> in the `#rafiki` channel for real-time discussions
18
+
- Start or join <LinkOuthref="https://github.com/interledger/rafiki/discussions">GitHub Discussions</LinkOut> for deeper technical conversations
19
+
20
+
-**Get hands-on**: Try [running the system locally](/integration/playground/overview) to familiarize yourself with Rafiki's functionality. Don't hesitate to ask questions in the `#rafiki` Slack channel!
21
+
22
+
### Make your first contribution
23
+
24
+
Ready to dive in? Here's how to review good first issues on GitHub if you are new to open source development.
25
+
26
+
#### 1: Navigate to the issues tab
27
+
28
+
Go to <LinkOuthref="https://github.com/interledger/rafiki/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22">good first issues</LinkOut> in the Rafiki repo.
29
+
30
+
#### 2: Check prerequisites
31
+
32
+
Make sure to review our comprehensive <LinkOuthref="https://github.com/interledger/rafiki/blob/main/.github/contributing.md">contribution guide</LinkOut>
33
+
34
+
Before claiming an issue, ensure you have:
35
+
36
+
- Read the issue description and comments
37
+
- Reviewed any linked documentation or related issues
38
+
- Understood the expected deliverables
39
+
- Confirmed the issue hasn't been resolved in a recent pull request
40
+
41
+
## 💻 Coding
16
42
17
43
- <LinkOuthref='https://github.com/interledger/rafiki'>Contribute</LinkOut> to Rafiki
18
44
coding or testing.
19
45
20
-
## Community and hackathons
46
+
## 📚 Documentation & learning
47
+
48
+
### Contribute to our documentation
49
+
50
+
- Improve existing documentation clarity and accuracy
51
+
- Create step-by-step tutorials for common use cases
52
+
- Develop troubleshooting guides and FAQ sections
53
+
- Translate documentation to the following languages:
54
+
- Arabic
55
+
- Chinese
56
+
- French
57
+
- German
58
+
- Japanese
59
+
- Portuguese
60
+
- Spanish
61
+
- Review translated and localized content
62
+
63
+
### Content creation
64
+
65
+
- Write blog posts about your Rafiki integration experiences
66
+
- Create video tutorials or demos
67
+
- Develop sample applications and code examples
68
+
- Share best practices and patterns you've discovered
69
+
70
+
## 🌟 Community building
71
+
72
+
### Events and engagement
73
+
74
+
- Attend the <LinkOuthref="https://interledger.org/summit">Interledger Summit</LinkOut> and participate in our annual hackathon
75
+
- Organize local meetups, coding sprints, and workshops
76
+
- Host online webinars or demo sessions
77
+
- Mentor new contributors and help them get started
78
+
79
+
### Hackathons
80
+
81
+
- Participate in existing hackathons using Rafiki
82
+
- Develop innovative applications and integrations
83
+
- Create proof-of-concept projects that showcase Rafiki's capabilities
84
+
- Collaborate with others on experimental features
21
85
22
-
- Join us at the <LinkOuthref="https://interledger.org/summit">Interledger Summit</LinkOut> and participate in our annual hackathon.
23
-
- Organize your own hackathons, coding sprints, and workshops both online and offline. Run campaigns and encourage participants to develop, collaborate on, and test projects.
86
+
## 🤝 Getting help
24
87
25
-
## Documentation
88
+
Stuck on something? We're here to help:
26
89
27
-
- Contribute to the docs by suggesting additions and improvements.
28
-
- Create tutorials and guides to help others in the community work with Rafiki.
Review our <LinkOuthref="https://github.com/interledger/rafiki/blob/main/.github/contributing.md">contribution guide</LinkOut> for details.
94
+
Remember, every contribution matters - whether it's a small documentation fix, a bug report, or a major feature implementation. We're excited to have you as part of the Rafiki community!
0 commit comments