Skip to content

Commit

Permalink
chore: update old links (#1351)
Browse files Browse the repository at this point in the history
* update old links

* update bug report template
  • Loading branch information
MarkNerdi authored Nov 8, 2023
1 parent b82792c commit d81fc23
Show file tree
Hide file tree
Showing 9 changed files with 69 additions and 154 deletions.
20 changes: 10 additions & 10 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Community Code of Conduct

In the IOTA community, participants from all over the world come together to create. This is made possible by the support, hard work and enthusiasm of thousands of people, including those who create and use the IOTA technology.
In the Bloom community, participants from all over the world come together to create. This is made possible by the support, hard work and enthusiasm of thousands of people, including those who create and use the IOTA technology.

This document offers some guidance to ensure IOTA participants can cooperate effectively in a positive and inspiring atmosphere, and to explain how together we can strengthen and support each other.
This document offers some guidance to ensure Bloom participants can cooperate effectively in a positive and inspiring atmosphere, and to explain how together we can strengthen and support each other.

This Code of Conduct is shared by all contributors and users who engage with the IOTA Foundation team and its community services.
This Code of Conduct is shared by all contributors and users who engage with the Bloom Labs team and its community services.

## Overview

Expand All @@ -17,33 +17,33 @@ This Code of Conduct presents a summary of the shared values and “common sense
- Supporting others in the community
- Getting support from others in the community

This Code of Conduct reflects the agreed standards of behavior for members of the IOTA community, in any social media platform, forum, mailing list, wiki, web site, discord channel, public meeting or private correspondence within the context of the IOTA Foundation team and the IOTA Tangle technology. The community acts according to the standards written down in this Code of Conduct and will defend these standards for the benefit of the community. Leaders of any group, such as moderators of social media groups, mailing lists, discord channels, forums, etc., will exercise the right to suspend access to any person who persistently breaks our shared Code of Conduct.
This Code of Conduct reflects the agreed standards of behavior for members of the Bloom community, in any social media platform, forum, mailing list, wiki, web site, discord channel, public meeting or private correspondence within the context of the Bloom team. The community acts according to the standards written down in this Code of Conduct and will defend these standards for the benefit of the community. Leaders of any group, such as moderators of social media groups, mailing lists, discord channels, forums, etc., will exercise the right to suspend access to any person who persistently breaks our shared Code of Conduct.

## Be considerate

Your actions and work will affect and be used by other people and you, in turn, will depend on the work and actions of others. Any decision you take will affect other community members, and we expect you to take those consequences into account when making decisions.

As a user, remember that community members work hard on their part of IOTA and take great pride in it.
As a user, remember that community members work hard on their part of Bloom and take great pride in it.

## Be respectful

In order for the IOTA community to stay healthy, its members must feel comfortable and accepted. Treating one another with respect is absolutely necessary for this. In a disagreement, in the first instance, assume that people mean well.
In order for the Bloom community to stay healthy, its members must feel comfortable and accepted. Treating one another with respect is absolutely necessary for this. In a disagreement, in the first instance, assume that people mean well.

We do not tolerate personal attacks, racism, sexism or any other form of discrimination. Disagreement is inevitable, from time to time, but respect for the views of others will go a long way to winning respect for your own view. Respecting other people, their work, their contributions and assuming well-meaning motivation will make community members feel comfortable and safe and will result in motivation and productivity.

We expect members of our community to be respectful when dealing with other contributors, users, and communities. Remember that IOTA is an international project and that you may be unaware of important aspects of other cultures.
We expect members of our community to be respectful when dealing with other contributors, users, and communities. Remember that Bloom is an international project and that you may be unaware of important aspects of other cultures.

## Be collaborative

Your feedback is important, as is its form. Poorly thought out comments can cause pain and the demotivation of other community members, but considerate discussion of problems can bring positive results. An encouraging word works wonders.

## Be pragmatic

The IOTA community is pragmatic and fair. We value tangible results over having the last word in a discussion. We defend our core values like freedom and respectful collaboration, but we don’t let arguments about minor issues get in the way of achieving more important results. We are open to suggestions and welcome solutions regardless of their origin. When in doubt support a solution which helps to get things done over one which has theoretical merits, but isn’t being worked on. Use the tools and methods which help to get the job done. Let decisions be taken by those who do the work.
The Bloom community is pragmatic and fair. We value tangible results over having the last word in a discussion. We defend our core values like freedom and respectful collaboration, but we don’t let arguments about minor issues get in the way of achieving more important results. We are open to suggestions and welcome solutions regardless of their origin. When in doubt support a solution which helps to get things done over one which has theoretical merits, but isn’t being worked on. Use the tools and methods which help to get the job done. Let decisions be taken by those who do the work.

## Support others in the community

The IOTA community is made strong by mutual respect, collaboration and pragmatic, responsible behavior. Sometimes there are situations where this has to be defended and other community members need help.
The Bloom community is made strong by mutual respect, collaboration and pragmatic, responsible behavior. Sometimes there are situations where this has to be defended and other community members need help.

If you witness others being attacked, think first about how you can offer them personal support. If you feel that the situation is beyond your ability to help individually, go privately to the victim and ask if some form of official intervention is needed.

Expand All @@ -55,4 +55,4 @@ Disagreements, both political and technical, happen all the time. Our community

Think deeply before turning a disagreement into a public dispute. If necessary, request mediation, and try to resolve differences in a less emotional medium. If you do feel that you or your work is being attacked, take your time to think things through before writing heated replies. Consider a 24-hour moratorium if emotional language is being used – a cooling-off period is sometimes all that is needed. If you really want to go a different way, then we encourage you to publish your ideas and your work, so that it can be tried and tested.

This work, "IOTA Community Guidelines", is a derivative of the [Community code of conduct by ownCloud](https://owncloud.org/community/code-of-conduct/), used under [CC BY-SA 3.0](https://creativecommons.org/licenses/by-sa/3.0/). "IOTA Community Guidelines" is licensed under [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/) by IOTA Foundation.
This work, "Bloom Community Guidelines", is a derivative of the [Community code of conduct by ownCloud](https://owncloud.org/community/code-of-conduct/), used under [CC BY-SA 3.0](https://creativecommons.org/licenses/by-sa/3.0/). "Bloom Community Guidelines" is licensed under [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/) by Bloom Labs.
67 changes: 13 additions & 54 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,9 @@ Thanks! :heart:

If you have a general or technical question, you can use one of the following resources instead of submitting an issue:

- [**Developer documentation:**](https://docs.iota.org/) For official information about developing with IOTA technology
- [**Discord:**](https://discord.iota.org/) For real-time chats with the developers and community members
- [**IOTA cafe:**](https://iota.cafe/) For technical discussions with the Research and Development Department at the IOTA Foundation
- [**StackExchange:**](https://iota.stackexchange.com/) For technical and troubleshooting questions
- [**IOTA documentation:**](https://wiki.iota.org/) For official information about developing with IOTA technology
- [**Developer documentation:**](https://docs.bloomwallet.io/) For official information about developing with Bloom wallet
- [**Discord:**](https://discord.gg/RjX3jEc7K7) For real-time chats with the developers and community members
</details>

<br>
Expand All @@ -28,7 +27,6 @@ To contribute to wallet on GitHub, you can:
- Report a bug
- Suggest a new feature
- Build a new feature
- Join the wallet Initiative
</details>

<br>
Expand All @@ -43,15 +41,15 @@ This section guides you through reporting a bug. Following these guidelines help

Please check the following list:

- **Do not open a GitHub issue for [security vulnerabilities](.github/SECURITY.MD)**, instead, please contact us at [security@iota.org](mailto:security@iota.org).
- **Do not open a GitHub issue for [security vulnerabilities](.github/SECURITY.MD)**, instead, please contact us at [security@bloomwallet.io](mailto:security@bloomwallet.io).

- **Ensure the bug was not already reported** by searching on GitHub under [**Issues**](https://github.com/iotaledger/wallet/issues). If the bug has already been reported **and the issue is still open**, add a comment to the existing issue instead of opening a new one.
- **Ensure the bug was not already reported** by searching on GitHub under [**Issues**](https://github.com/bloomwalletio/bloom/issues). If the bug has already been reported **and the issue is still open**, add a comment to the existing issue instead of opening a new one.

**Note:** If you find a **Closed** issue that seems similar to what you're experiencing, open a new issue and include a link to the original issue in the body of your new one.

### Submitting a bug report

To report a bug, [open a new issue](https://github.com/iotaledger/wallet/issues/new), and be sure to include as many details as possible, using the template.
To report a bug, [open a new issue](https://github.com/bloomwalletio/bloom/issues/new?assignees=&labels=bug-report&projects=&template=bug_report.yml&title=%F0%9F%90%9E+-+), and be sure to include as many details as possible, using the template.

**Note:** Minor changes such as fixing a typo can but do not need an open issue.

Expand All @@ -68,13 +66,11 @@ This section guides you through suggesting a new feature. Following these guidel

### Before suggesting a new feature

**Ensure the feature has not already been suggested** by searching on GitHub under [**Issues**](https://github.com/iotaledger/wallet/issues).
**Ensure the feature has not already been suggested** by searching on GitHub under [**Issues**](https://github.com/bloomwalletio/bloom/issues).

### Suggesting a new feature

To suggest a new feature, talk to the IOTA community and IOTA Foundation members in the #wallet-discussion channel on [Discord](https://discord.iota.org/).

Or, you can submit an official [Request for Comments (RFC)](https://github.com/iotaledger/wallet-rfcs/).
To suggest a new feature, talk to the Bloom team on the [Discord Server](https://discord.gg/RjX3jEc7K7).

</details>

Expand All @@ -88,42 +84,13 @@ This section guides you through building a new feature. Following these guidelin

### Before building a new feature

Make sure to discuss the feature in the #wallet-discussion channel on [Discord](https://discord.iota.org/).
Make sure to discuss the feature on [Discord](https://discord.gg/RjX3jEc7K7).

Otherwise, your feature may not be approved at all.

### Building a new feature

To build a new feature, check out a new branch based on the `develop` branch, and be sure to document any public-facing APIs, using Rust code comments.
</details>

<br>

<details>
<summary>Join the wallet Initiative :deciduous_tree:</summary>
<br>

The [wallet Initiative](https://github.com/iota-community/wallet) is a collaborative effort to improve the wallet developer experience by focussing on the following goals:

- Quality Assurance and Quality Control
- Documentation
- Benchmarks
- RFCs
- Node usability
- Improvements to modules and libraries

## How much time is involved

You can invest as much or as little time as you want into the initiative.

## What's in it for you

In return for your time, not only do you get to be a part of the future of IOTA technology, you will also be given a badge on Discord to show others that you're a valuable member of the IOTA community.

## How to join

If you're interested in joining, chat to us in the #experience channel on [Discord](https://discord.iota.org/).

To build a new feature, check out a new branch based on the `develop` branch.
</details>

<br>
Expand All @@ -144,28 +111,20 @@ Before submitting a pull request, please follow these steps to have your contrib

**Note:** You don't need to open an issue for minor changes such as typos, but you can if you want.

- All public interfaces should have descriptive documentation, including an
example that compiles and passes [documentation tests](https://doc.rust-lang.org/rustdoc/documentation-tests.html)

- All instances of `unsafe` should have a comment that explains why its use was unavoidable

- All code should be well formatted and linted, passing our [linting continuous integration](https://github.com/bloomwalletio/bloom/blob/develop/.github/workflows/ci.lint.yml) workflow

- All code should be well tested, passing (unit _and_ integration tests) both locally and in our [testing continuous integration](https://github.com/bloomwalletio/bloom/blob/develop/.github/workflows/ci.test.yml) workflow

- If your changes include modification or adding of dependencies, once your PR is approved it must then be merged into a `snyk/branch-prefix/branch-name` on the main Bloom repository to test said changes with the [Snyk continuous integration](https://github.com/bloomwalletio/bloom/blob/develop/.github/workflows/ci.snyk.yml) workflow

- To be compatible with the guidelines of the Eclipse foundation, all code must be licensed under the [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0). This license must be referenced in every crate of the workspace (add [`./LICENSE`] to the crate's top level directory). For Rust crates, every `Cargo.toml` must contain the line `license = "Apache-2.0"`.

### Submitting a pull request

The following is a typical workflow for submitting a new pull request:

1. Fork this repository
2. Create a new branch based on your fork. For example, `git checkout -b fix/my-fix` or ` git checkout -b feat/my-feature`.
3. Run the `rustfmt` command to make sure your code is well formatted
3. Run the `yarn check:types && yarn lint && yarn test:shared` command to make sure your code is well formatted
4. Commit changes and push them to your fork
5. Target your pull request to be merged with `master`
5. Target your pull request to be merged with `develop`

If all [status checks](https://help.github.com/articles/about-status-checks/) pass, and the maintainer approves the PR, it will be merged.

Expand All @@ -178,4 +137,4 @@ If all [status checks](https://help.github.com/articles/about-status-checks/) pa
<summary>Code of Conduct :clipboard:</summary>
<br>

This project and everyone participating in it is governed by the [IOTA Code of Conduct](.github/CODE_OF_CONDUCT.md).
This project and everyone participating in it is governed by the [Bloom Code of Conduct](.github/CODE_OF_CONDUCT.md).
Loading

0 comments on commit d81fc23

Please sign in to comment.