Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README to change the note about support. #438

Merged
merged 5 commits into from
Dec 31, 2024
Merged

Conversation

sporkmonger
Copy link
Contributor

@sporkmonger sporkmonger commented Dec 31, 2024

The company is shutting down, but the project will remain supported in a personal capacity.

Summary by CodeRabbit

  • Documentation
    • Updated README to highlight community-driven development of Bulwark
    • Revised support section to emphasize individual development and community contributions
    • Adjusted formatting of documentation to reflect community-oriented approach

@sporkmonger sporkmonger added kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. kind/docs Categorizes issue or PR as related to documentation. labels Dec 31, 2024
@sporkmonger sporkmonger added this to the Release 0.7.0 milestone Dec 31, 2024
Copy link
Contributor

coderabbitai bot commented Dec 31, 2024

Walkthrough

The pull request modifies the documentation in the docs/README.md file, specifically updating the section about Bulwark's support model. The change transitions from a commercial support narrative to a community-driven approach, highlighting that Bulwark is now developed and supported by an individual named Bob Aman. The update emphasizes community contributions and removes previous references to commercial services and early access discounts.

Changes

File Change Summary
docs/README.md Updated Bulwark support section to emphasize community development and contributions; removed references to commercial support and professional services; adjusted bullet point formatting.

Poem

🐰 A Rabbit's Ode to Open Source Delight

Bulwark's path now takes a new flight,
From commerce to community's might,
Bob's passion, a beacon so bright,
Contributions welcome, day and night!
Open code dances with pure delight 🌟


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2096899 and 6ac8a4a.

📒 Files selected for processing (1)
  • docs/README.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/README.md

🪧 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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

Copy link

dryrunsecurity bot commented Dec 31, 2024

DryRun Security Summary

The pull request updates the Bulwark project's documentation to remove references to commercial support and services, signaling a shift towards a more community-driven, open-source approach.

Expand for full summary

Summary:

The code changes made in this pull request are focused on updating the documentation for the Bulwark project, specifically the README file located at docs/README.md. The key changes include the removal of the section about Bulwark being "Commercially Supported" by Bulwark Security PBC, and the removal of mentions of Bulwark offering a commercial ruleset, paid support, and professional services. These changes suggest a shift in the project's commercial strategy, moving away from a paid model towards a more community-driven, open-source approach.

From an application security perspective, these changes do not directly impact the security of the Bulwark application itself. However, they do indicate a change in the project's direction and support model, which could have indirect implications for the project's long-term sustainability and the availability of commercial support options for users who may require them. While the move towards a more community-driven, open-source approach could be beneficial for the project's adoption and growth, it may also mean that certain commercial support options are no longer available.

Files Changed:

  • docs/README.md: The key changes in this file include the removal of the section about Bulwark being "Commercially Supported" by Bulwark Security PBC, and the removal of mentions of Bulwark offering a commercial ruleset, paid support, and professional services. These changes suggest a shift in the project's commercial strategy, moving away from a paid model towards a more community-driven, open-source approach.

Code Analysis

We ran 9 analyzers against 1 file and 0 analyzers had findings. 9 analyzers had no findings.

View PR in the DryRun Dashboard.

Copy link

DryRun Security Summary

The pull request updates the README's "Supported" section to remove commercial references, highlight community involvement, and emphasize the project's ongoing development by its primary maintainer.

Expand for full summary

Summary:

The code changes in this pull request update the "Supported" section of the README file for the Bulwark project. The key changes include the removal of the "Commercially Supported" mention and the cloud admin application reference, as well as the addition of information about the freely available community ruleset and the invitation for anyone to contribute to it.

From an application security perspective, these changes do not raise any immediate concerns. The shift towards a more community-driven approach could be positive for the project's security posture if it leads to increased transparency and involvement from the broader security community. The addition of the community ruleset information is also a positive step, as it encourages contributions and collaboration, which can help improve the quality and security of the detection rules over time. Overall, these updates seem reasonable and in line with the project's goals, as long as the Bulwark project continues to maintain its focus on security.

Files Changed:

  • docs/README.md: The "Supported" section of the README file has been updated to remove the "Commercially Supported" mention and the reference to a "Bulwark cloud admin application". The section now simply states that "Bulwark is actively developed and supported by Bob Aman". Additionally, information about a "freely available community ruleset" and an invitation for anyone to contribute to it has been added.

Code Analysis

We ran 9 analyzers against 1 file and 0 analyzers had findings. 9 analyzers had no findings.

View PR in the DryRun Dashboard.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
docs/README.md (1)

41-44: LGTM! Clear and transparent support information.

The updated support section effectively communicates the transition while maintaining a positive, community-oriented tone. The inclusion of direct links to both the maintainer and community ruleset provides clear paths for user engagement.

Consider adding a brief mention of how users can get support (e.g., through GitHub issues/discussions) to make the support channels more explicit. For example:

 - **Supported.** Bulwark is actively developed and supported by
     [Bob Aman](https://github.com/sporkmonger). There is a freely available
     [community ruleset](https://github.com/bulwark-security/bulwark-community-ruleset) which anyone is welcome
-    to contribute to.
+    to contribute to. Support is provided through GitHub issues and discussions.
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5b7d7e6 and 2096899.

📒 Files selected for processing (1)
  • docs/README.md (1 hunks)

@sporkmonger sporkmonger merged commit cf35bb5 into main Dec 31, 2024
19 checks passed
@sporkmonger sporkmonger deleted the update-readme branch December 31, 2024 22:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. kind/docs Categorizes issue or PR as related to documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant