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

feat(BUX-705): added gitbook #209

Merged
merged 7 commits into from
Apr 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Code of Conduct

## 1. Purpose

The primary goal of this project is to foster an inclusive, respectful, and open community for everyone, regardless of their background or identity. This Code of Conduct outlines our expectations for participant behavior and the consequences for unacceptable behavior.

## 2. Open Discussions & Respectful Feedback

- **Encourage Diverse Ideas:** Everyone brings a unique perspective. Encourage different viewpoints, and listen openly to each other’s ideas.

- **Constructive Feedback:** Focus on providing constructive feedback rather than criticizing individuals. Discuss ideas, not the person presenting them.

- **Avoid Harmful Language:** Refrain from using offensive or harmful language, including but not limited to sexist, racist, homophobic, transphobic, ableist, or discriminatory remarks.

## 3. No Politics or Off-topic Discussions

- **Stay On Topic:** Keep discussions focused on the project and avoid bringing in off-topic or political discussions.

- **Respectful Discourse:** If discussions become heated, maintain a level of respect and understanding, and work towards a compromise.

## 4. Reporting & Enforcement

- **Report Violations:** If you observe a violation of this Code of Conduct, please report it by contacting the project team members.

- **Consequences:** Violations of this Code of Conduct may result in temporary or permanent banning from the project community.

## 5. Inclusion & Diversity

- **Welcome Everyone:** Foster an environment where everyone feels welcome, regardless of their background, identity, or level of experience.

- **Help Newcomers:** Offer help and guidance to newcomers to make them feel welcome in our community.

## 6. Be Kind & Courteous

- **Respect Time & Effort:** Recognize and respect the time and effort put in by contributors and maintainers.

- **Courtesy:** Be courteous and polite. Treat others as you would like to be treated.

By participating in this project, you agree to abide by this Code of Conduct. Let’s work together to make this community respectful and inclusive for everyone.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
[![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat&v=2)](https://github.com/RichardLitt/standard-readme)
[![Makefile Included](https://img.shields.io/badge/Makefile-Supported%20-brightgreen?=flat&logo=probot&v=2)](Makefile)


<br/>
</div>

Expand Down Expand Up @@ -47,6 +48,8 @@ go get -u github.com/bitcoin-sv/spv-wallet-go-client
## Documentation
View the generated [documentation](https://pkg.go.dev/github.com/bitcoin-sv/spv-wallet-go-client)

For in-depth information and guidance, please refer to the [SPV Wallet Documentation](https://bsvblockchain.gitbook.io/docs).

[![GoDoc](https://godoc.org/github.com/bitcoin-sv/spv-wallet-go-client?status.svg&style=flat&v=2)](https://pkg.go.dev/github.com/bitcoin-sv/spv-wallet-go-client)

<br/>
Expand Down
Loading