Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
FLOSS Best practices Passing
  • Loading branch information
Rashmi-278 committed Aug 28, 2024
1 parent 205913c commit 9cc9872
Showing 1 changed file with 78 additions and 3 deletions.
81 changes: 78 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,85 @@
# DAOstar: DAO Standards

![FLOSS Best Practices](https://bestpractices.coreinfrastructure.org/projects/YOUR_PROJECT_ID/badge)
![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)

## Introduction

This repo contains the website for [daostar.org](https://daostar.org) as well as reference implementations, schemas, and other assets related to DAO standards, DAO Improvement Proposals (DAOIPs), including but not limited to EIP-4824: Common Interfaces for DAOs.
DAOstar is an initiative focused on creating and maintaining standards for Decentralized Autonomous Organizations (DAOs). This repository hosts the website for [daostar.org](https://daostar.org), as well as reference implementations, schemas, and other assets related to DAO standards, including but not limited to EIP-4824: Common Interfaces for DAOs.

DAOstar aims to provide a unified framework for DAOs, making it easier for organizations to adopt and implement standards that ensure interoperability, security, and ease of use.

The project is maintained by [DAOstar One](https://daostar.one) with support from [Metagov](https://metagov.org).

## Project Overview

DAOstar's primary objective is to develop and maintain standards for DAOs, helping to foster a more interoperable and secure ecosystem. This repository includes:

- **Schemas and Reference Implementations**: Standards and code to help DAOs adopt common practices.
- **DAO Improvement Proposals (DAOIPs)**: Contributions to evolving the DAO ecosystem.
- **Website**: Source code for [daostar.org](https://daostar.org).

## Getting Started

It is maintained by [DAOstar One](https://daostar.one) with support from [Metagov](https://metagov.org).
To start using or contributing to DAOstar, visit our [documentation site](https://docs.daostar.org) for detailed guides on setup, usage, and contribution.

# Licenses
### How to Contribute

We welcome contributions from the community! To contribute:

1. **Submit Issues and Feedback**: Report bugs or suggest enhancements by opening an issue on our [GitHub repository](https://github.com/metagov/daostar/issues).
2. **Pull Requests**: If you have a fix or enhancement, fork the repository and submit a pull request. Make sure to follow the [contribution guidelines](#contribution-guidelines).

### Contribution Guidelines

- **Coding Standards**: Adhere to the coding standards specified in the [style guide](CONTRIBUTING.md).
- **Testing**: Ensure your code is covered by tests. We use [GitHub Actions](https://github.com/features/actions) for continuous integration.
- **Documentation**: Update documentation for any changes to the codebase. Ensure your contribution is well-documented.

For more details, see the [CONTRIBUTING.md](CONTRIBUTING.md) file.

### License

All code in this repository is licensed under the MIT License, except for published standards, which are released to the public domain under [CC0](https://creativecommons.org/share-your-work/public-domain/cc0/).

### Documentation

- **Basic Documentation**: Find basic project documentation at [docs.daostar.org](https://docs.daostar.org).
- **Interface Documentation**: Detailed reference documentation describing the external interface of the software is available in the "How to" section of the docs.

### Security and Best Practices

We follow industry best practices for secure development:

- **Cryptographic Practices**: We use publicly reviewed and expert-published cryptographic protocols and algorithms.
- **Static and Dynamic Analysis**: The project undergoes both static and dynamic code analysis to identify and mitigate vulnerabilities.
- **Vulnerability Reporting**: Report vulnerabilities via GitHub Issues or by emailing [email protected], [email protected], [email protected], [email protected].

### Reporting

If you encounter a bug or wish to report a vulnerability, we encourage you to take the following steps:

- **Bug Reports**: Please open an issue on our [GitHub repository](https://github.com/metagov/daostar/issues) with details about the bug, steps to reproduce, and any other relevant information.
- **Vulnerability Reports**: If you discover a security vulnerability, we ask that you report it privately by emailing the following addresses:
- Rashmi V Abbigeri: [[email protected]](mailto:[email protected])
- Fernando Mendes: [[email protected]](mailto:[email protected])
- Josh: [[email protected]](mailto:[email protected])
- Aman: [[email protected]](mailto:[email protected])

We take all reports seriously and will work to address any issues as quickly as possible.

### Reporting and Release Notes

We publish a release every month, detailing the changes and updates made to the project. These releases are documented in the [Releases section](https://github.com/metagov/daostar/releases) of our GitHub repository.

## Additional Information

- **Working Build System**: We use Netlify and GitHub CI/CD for our build and deployment pipeline.
- **Communication Channels**: Discussions and proposals are handled via GitHub Issues, ensuring transparency and openness.
- **Maintained Project**: The project is actively maintained with commits and updates made on a weekly or bi-weekly basis.

---

Thank you for your interest in DAOstar. We look forward to your contributions!

For more information, visit [daostar.org](https://daostar.org).

0 comments on commit 9cc9872

Please sign in to comment.