ArcBlock Community Posting Guidelines

wangshijun May 22, 2024

Welcome to the ArcBlock Community! This is your platform to share insights, report bugs, seek help, and inspire innovation together. To ensure our community remains a vibrant and productive space for everyone, we have crafted some guidelines that all members should follow. Let's create an environment that fosters collaboration and growth!

Before Starting

We kindly request that you set a proper name and avatar for your community profile to ensure easy identification by other members. If you did not do so during your initial login, please update your profile by following the documentation:

How do I update profile?

General Posting Rules

Respect and Courtesy: Treat all members with respect. Personal attacks, harassment, and offensive language will not be tolerated.
Stay On Topic: Make sure your contributions are relevant to the topic being discussed. This helps maintain a structured and useful discussion.
Search Before Posting: Before creating a new thread, please use the search feature to find existing discussions that might address your question or topic. This reduces duplicates and helps you find answers more quickly.
Protect Privacy: Do not share personal information about yourself or others. This includes private messages, email addresses, and sensitive data.
No Spam: Refrain from posting promotional material, advertisements, or repetitive posts. Our community is a place for growth, not spam.
Use Clear and Descriptive Titles: Your title should be concise and descriptive to help members quickly understand the topic of your post.

Reporting Bugs

When reporting bugs, clarity is key. Here’s how to do it effectively:

Title: Start with a concise title that clearly states the problem, including the feature or function where the bug occurred.
Description: Provide a detailed description of the issue. Include steps to reproduce the bug, what you expected to happen, and what actually happened.
Screenshots/Videos: If possible, include visuals to help illustrate the issue. This can be crucial for understanding the context and specifics of the bug. Again, please do not include sensitive info in the screenshot or video.
Environment: Mention any relevant details about your environment, such as the browser version, operating system, and any specific settings relevant to the bug.

Choosing the Right Board

To help streamline support and discussion: We have several boards for different topics. Choose the one that best fits your post’s theme. If you are certain which product you are using, you can just post a new thread on that board:

The "DID Wallet" board is a good place for posts related to DID Wallet
The "NFT Studio" board is a good place for NFT creating, minting related
The "Blocklet Platform" board is the place for ArcBlock official service and blocklet developer related issues
...

If you’re uncertain:

The "Miscellaneous" board is a good place for general discussions.
The "Support" board is a good place to seek help.

Choosing the Right Labels

Labels are powerful tools for organizing discussions and enhancing the discoverability of your posts. They help in quickly identifying the nature and context of the issues or ideas being presented. When creating a new post, please consider applying the following labels appropriately (other labels are meant to be used by moderator only).

Category Labels

Category/Bug: Use this label when reporting a malfunction or error in the system that needs attention.
Category/Feature: Apply this label if you are proposing a new feature or enhancement.
Category/Discussion: Choose this label for general discussions that may not necessarily fit into bugs or feature requests but are important for community engagement and brainstorming.

Area Labels

Area/Docs: Attach this label if your post identifies issues or necessary improvements in the documentation.
Area/Tutorial: Use this label when discussing tutorials, whether you're providing feedback, asking for help, or suggesting new tutorial content.
Area/UX: Appropriate for posts related to user experience aspects, such as interface design, interaction flows, and usability improvements.
Area/Security: Critical for discussions or reports concerning security vulnerabilities, data protection, and safe application practices.
Area/Reliability: This should be used when addressing concerns about the reliability of workflows, system processes, or any feature that affects the robust operation of the platform.
Area/Performance: Ideal for posts that point out performance issues. Use this label if something in the system is slower than expected or needs optimization for speed and efficiency.

Using Labels Effectively

When you choose a label, think about the primary focus of your post:

Ensure the label matches the content of your post to keep the community organized and make it easier for other members to provide relevant feedback or assistance.
You can use multiple labels if your post spans several areas; for example, a bug in the documentation could be tagged with both Category/Bug and Area/Docs.
Review the labels periodically to make sure they still align with the content as discussions evolve.

Engage and Inspire

While you’re here, look around, ask questions, and share your experiences. Your insights could lead to the next big idea or solution that pushes the community forward. Let's keep the passion for innovation burning bright and support each other in making the ArcBlock community a beacon for open collaboration and advancement.

Together, we can drive the future of decentralized applications. Thank you for being an essential part of our community's growth and innovation. Let’s build something extraordinary together!