Contributing docs

[nya-elimu]

Which issue does this PR address?

elimu-ai/web3-wiki#54

Summary by CodeRabbit

• New Features
  • Introduced a CONTRIBUTING.md file with guidelines for contributors and information on funding splits.
  • Added a FUNDING.json file to manage Ethereum-related funding details.

These changes aim to enhance community engagement and streamline the contribution process while providing clear funding management.

[coderabbitai]

Walkthrough

The changes introduce two new files, CONTRIBUTING.md and FUNDING.json, to the elimu.ai project. The CONTRIBUTING.md file provides guidelines for contributors, including information on funding splits and instructions for adding Ethereum addresses. The FUNDING.json file contains a structured JSON object detailing Ethereum funding information, specifically the ownership of funding.

Changes

File(s)	Change Summary
CONTRIBUTING.md	Added contributing guidelines and funding splits information.
FUNDING.json	Introduced a JSON structure for managing Ethereum funding details, including ownership.

Assessment against linked issues

Objective	Addressed	Explanation
Adjust drip list funding splits (Sep 2024) (#54)	✅

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between a32e514 and 2d798f8.

Files ignored due to path filters (1)

• FUNDING_SPLITS.csv is excluded by !**/*.csv

Files selected for processing (2)

• CONTRIBUTING.md (1 hunks)
• FUNDING.json (1 hunks)

Files skipped from review due to trivial changes (1)

• FUNDING.json

Additional context used

LanguageTool

CONTRIBUTING.md

[uncategorized] ~10-~10: A punctuation mark might be missing here.
Context: ...-recommender should reflect the data in FUNDING_SPLITS.csv...

(AI_EN_LECTOR_MISSING_PUNCTUATION)

Markdownlint

CONTRIBUTING.md

5-5: null
Bare URL used

(MD034, no-bare-urls)

---

10-10: null
Bare URL used

(MD034, no-bare-urls)

Additional comments not posted (1)

CONTRIBUTING.md (1)

12-12: LGTM!

The code segment provides a clear link to more information about the funding splits in the project's Web3 Wiki.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

Outside diff range, codebase verification and nitpick comments (2)

CONTRIBUTING.md (2)

1-6: LGTM! Consider fixing the bare URL.

The code segment provides a clear title and a useful link to the project's main contributing guidelines.

To improve readability and maintainability, consider wrapping the bare URL in a Markdown link:

-See https://github.com/elimu-ai/wiki/blob/main/CONTRIBUTING.md
+See [elimu.ai Contributing Guidelines](https://github.com/elimu-ai/wiki/blob/main/CONTRIBUTING.md)

Tools

Markdownlint

5-5: null
Bare URL used

(MD034, no-bare-urls)

---

7-10: LGTM! Consider adding a missing punctuation mark.

The code segment provides clear instructions for contributors regarding funding splits.

To improve readability, consider adding a period at the end of the sentence in the note:

-If your GitHub username is in `FUNDING_SPLITS.csv`, open a pull request to add your Ethereum address next to it
+If your GitHub username is in `FUNDING_SPLITS.csv`, open a pull request to add your Ethereum address next to it.

Tools

LanguageTool

[uncategorized] ~10-~10: A punctuation mark might be missing here.
Context: ...-recommender should reflect the data in FUNDING_SPLITS.csv...

(AI_EN_LECTOR_MISSING_PUNCTUATION)

Markdownlint

10-10: null
Bare URL used

(MD034, no-bare-urls)