🌱 CONTRIBUTING

by p1r0

4 min read

PARTNERS

If you stumbled upon this file, it suggests that you're genuinely interested. It's crucial that the project remains decentralized and free, as this empowers participants and contributors to key participants of a public good that fosters sovereignty, privacy, and decentralization in climate change measurement.

Let's together create our own version where individuals can model the future of carbon offsetting and their own governance.

🧑💻 Code of Conduct

This project adheres to No Code of Conduct. We are all adults. We accept anyone's contributions. Nothing else matters.

For more information please visit the No Code of Conduct homepage.

📚 Resources

📝 Docs

🔗 Issues

👥 Comms

🧪 Testing

A bit of this workshop might be usefull

🔧 Issues

First look for the issues with rad issue list --all to check if it was previously added or already solved. if there is you can comment into it, if not you can create a new issue. please add the following labels and sections regarding the type of issue you submit.

Types:

each time you submit an issue you can use one of the following templates and add the specified label with the name (enhancement, bug, docs):

rad issue label <issue-id> [--add <label>]

🚀 Enhancement

enhancements are features that you might like to suggest to a project

# Title:
[Describe the main feature or improvement in a concise manner.]

## Description:
[Provide a detailed explanation of the enhancement including why this is important and how it could positively impact the product. Include specific use cases if applicable.]

## Proposed Solution:
[Outline your proposed solution to address the issue. If there are multiple possible solutions, list them all and justify why you believe one is preferable.]

## Benefits:
[Explain the benefits of implementing this enhancement, such as increased efficiency, improved user experience, or enhanced functionality.]

## Impact on Existing Features:
[Discuss how this new feature will interact with existing features, any potential conflicts, and how it might improve or streamline those processes.]

## Implementation Details:
[List any additional details needed for the implementation of this enhancement. This could include technical requirements, timelines, dependencies, etc.]

## Risks and Mitigation:
[Identify any risks associated with implementing this enhancement and outline strategies to mitigate those risks.]

🐛 bug

When reporting a bug, your goal is to clearly describe an issue that prevents the product from functioning correctly. Your description should include steps to reproduce the problem, expected behavior, and actual behavior.

# Title:
[Describe the bug in a concise manner.]

## Description:
[Provide a detailed explanation of what happened. Include specific actions taken before the issue appeared, any error messages displayed, and screenshots if applicable.]

## Steps to Reproduce:
[List step-by-step instructions that can be followed to reproduce the issue. Be as detailed as possible so others can follow along easily.]

## Expected Behavior:
[Describe what should have happened instead of the actual behavior.]

## Actual Behavior:
[Describe what actually happened when you performed the steps to reproduce the issue.]

## Environment:
[Specify the environment in which the bug was observed, including operating system, browser version, device type, etc.]

## Possible Causes:
[Based on your knowledge and experience, suggest possible causes of the bug. This can help the development team narrow down the problem more quickly.]

## Impact on User Experience:
[Describe how this bug affects the user experience. If it's particularly disruptive or critical, explain its impact.]

## Additional Information:
[Include any additional information that could be helpful for reproducing the issue or understanding the context in which it occurred.]

📝docs

When reporting a documentation issue, your goal is to describe an error or missing information within the product's documentation. Your description should include details about what's incorrect or missing.

# Title:
[Describe the documentation issue in a concise manner.]

## Description:
[Provide a detailed explanation of what needs correction or is missing in the documentation. Include specific sections or pages that are affected.]

## Corrected Information:
[If known, provide the correct information that should replace the existing text. If you're not sure about the correct information, state this clearly.]

## Impact on Users:
[Explain how this documentation issue affects users trying to use the product. For example, if a step is unclear or missing, it could lead to errors or confusion.]

## Suggested Fixes:
[List any suggestions for correcting the documentation, such as adding missing sections, updating text, or reorganizing information.]

## Related Links:
[Include links to related pages or resources that might help understand the issue more fully. This could include forum discussions, video tutorials, or other external sources of information.]

💰 Bounty

If the DAO solves a request or writes a bounty proposal issue, this label will be added, and add the following data/template to the issue:

## Difficulty

Easy | Medium | Hard

## Deadline
2024-11-11 (where format goes YYYY-MM-DD)

## Reward Proposal

| Token | Token | Network |	USD |
|-------|-------|---------|-----|
| 0xAEF | ETH   | ARB	  | 25	|
| 0xD3E | ETH   | ARB	  | 20	|

> Notice example payments table in ETH equivalent to USD for two addresses
involved in solving the issue.

## Voted/approved reference

if required add where this request was approved or specified

💻 Codding conventions

  • MarkDown

🔄 Pull Requests

How to submit changes

radicle patches

😊 Thank you

Thank you for taking the time to consider contributing to the DECA Project. Special thanks to our partners and contributors

👤💻 Who is currently involved? (Humans)

Maintainer and Architect