Skip to content

Commit d047e65

Browse files
authored
BN-4375 [FEATURE] Update documentation
1 parent 2a20dfd commit d047e65

File tree

3 files changed

+6
-7
lines changed

3 files changed

+6
-7
lines changed

CODE_OF_CONDUCT.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ representative at an online or offline event.
5656
## Enforcement
5757

5858
Instances of abusive, harassing, or otherwise unacceptable behavior may be
59-
reported to the community leaders responsible for enforcement at <pawel.kozielecki@netguru.com>.
59+
reported to the community leaders responsible for enforcement at <network-module-ios@netguru.com>.
6060
All complaints will be reviewed and investigated promptly and fairly.
6161

6262
All community leaders are obligated to respect the privacy and security of the
@@ -67,4 +67,4 @@ reporter of any incident.
6767
This Code of Conduct is adapted from the [Contributor Covenant](https://contributor-covenant.org/), version
6868
[1.4](https://www.contributor-covenant.org/version/1/4/code-of-conduct/code_of_conduct.md) and
6969
[2.0](https://www.contributor-covenant.org/version/2/0/code_of_conduct/code_of_conduct.md),
70-
and was generated by [contributing-gen](https://github.com/bttger/contributing-gen).
70+
and was generated by [contributing-gen](https://github.com/bttger/contributing-gen).

CONTRIBUTING.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ All types of contributions are encouraged and valued. See the [Table of Contents
2828
This project and everyone participating in it is governed by the
2929
[Netguru iOS Networking Module Code of Conduct](https://github.com/netguru/ng-ios-network-moduleblob/master/CODE_OF_CONDUCT.md).
3030
By participating, you are expected to uphold this code. Please report unacceptable behavior
31-
to <pawel.kozielecki@netguru.com>.
31+
to <network-module-ios@netguru.com>.
3232

3333

3434
## I Have a Question
@@ -58,7 +58,7 @@ A good bug report shouldn't leave others needing to chase you up for more inform
5858

5959
- Make sure that you are using the latest version.
6060
- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the [documentation](). If you are looking for support, you might want to check [this section](#i-have-a-question)).
61-
- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](https://github.com/netguru/ng-ios-network-moduleissues?q=label%3Abug).
61+
- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already an issue report existing in the [issues](https://github.com/netguru/ng-ios-network-module/issues) section.
6262
- Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue.
6363
- Collect information about the bug:
6464
- Stack trace (Traceback)
@@ -91,7 +91,7 @@ This section guides you through submitting an enhancement suggestion for Netguru
9191
#### Before Submitting an Enhancement
9292

9393
- Make sure that you are using the latest version.
94-
- Read the [documentation]() carefully and find out if the functionality is already covered, maybe by an individual configuration.
94+
- Read the [documentation](https://github.com/netguru/ng-ios-network-module/blob/main/README.md) in the readme carefully and find out if the functionality is already covered, maybe by an individual configuration.
9595
- Perform a [search](https://github.com/netguru/ng-ios-network-module/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
9696
- Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library.
9797

@@ -102,5 +102,5 @@ Enhancement suggestions are tracked as [GitHub issues](https://github.com/netgur
102102
- Use a **clear and descriptive title** for the issue to identify the suggestion.
103103
- Provide a **step-by-step description of the suggested enhancement** in as many details as possible.
104104
- **Describe the current behavior** and **explain which behavior you expected to see instead** and why. At this point you can also tell which alternatives do not work for you.
105-
- You may want to **include screenshots and animated GIFs** which help you demonstrate the steps or point out the part which the suggestion is related to. You can use [this tool](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and [this tool](https://github.com/colinkeenan/silentcast) or [this tool](https://github.com/GNOME/byzanz) on Linux.
105+
- You may want to **include screenshots and animated GIFs** which help you demonstrate the steps or point out the part which the suggestion is related to. You can use [this tool](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows.
106106
- **Explain why this enhancement would be useful** to most Netguru iOS Networking Module users. You may also want to point out the other projects that solved it better and which could serve as inspiration.

README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -264,6 +264,5 @@ This project is licensed under the MIT License.
264264

265265
## Related repositories
266266

267-
- [Netguru Pinning Engine](https://github.com/netguru/pinning-engine-ios)
268267
- [Highway](https://github.com/netguru/highway)
269268
- [Response Detective](https://github.com/netguru/ResponseDetective)

0 commit comments

Comments
 (0)