Skip to content

Commit

Permalink
Merge pull request #21 from gopher-utils/chore/rename-repo
Browse files Browse the repository at this point in the history
refactor: update repo url and add codeowners
  • Loading branch information
adarsh-a-tw authored Oct 6, 2023
2 parents ee55347 + b591f7a commit 1d35847
Show file tree
Hide file tree
Showing 10 changed files with 21 additions and 27 deletions.
File renamed without changes.
3 changes: 3 additions & 0 deletions CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# These owners will be the default owners for everything in
# the repo. Unless a later match takes precedence,
* @gopinathr143 @adarsh-a-tw @aswath-s-tw
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ All types of contributions are encouraged and valued. See the [Table of Contents

## I Have a Question

> If you want to ask a question, we assume that you have read the available [Documentation](https://pkg.go.dev/github.com/gopinathr143/go-collections).
> If you want to ask a question, we assume that you have read the available [Documentation](https://pkg.go.dev/github.com/gopher-utils/go-collections).
Before you ask a question, it is best to search for existing [Issues](/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.

Expand Down Expand Up @@ -71,7 +71,7 @@ This section guides you through submitting an enhancement suggestion, **includin
#### Before Submitting an Enhancement

- Make sure that you are using the latest version.
- Read the [documentation](https://pkg.go.dev/github.com/gopinathr143/go-collections) carefully and find out if the functionality is already covered.
- Read the [documentation](https://pkg.go.dev/github.com/gopher-utils/go-collections) carefully and find out if the functionality is already covered.
- Perform a [search](/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.
- 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.

Expand Down Expand Up @@ -112,7 +112,7 @@ golangci-lint run

### Improving The Documentation

We use godoc to generate and host our documentation(https://pkg.go.dev/github.com/gopinathr143/go-collections). If you find issues with existing documentation or have suggestions for enhancements, please create an issue/PR with necessary changes.
We use godoc to generate and host our documentation(https://pkg.go.dev/github.com/gopher-utils/go-collections). If you find issues with existing documentation or have suggestions for enhancements, please create an issue/PR with necessary changes.

## Styleguides

Expand Down
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2023 Gopinath Rakkiyannan
Copyright (c) 2023 gopher-utils

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
21 changes: 6 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,10 @@
# go-collections
<p>
<img src="https://github.com/gopinathr143/go-collections/actions/workflows/pr-actions.yml/badge.svg" alt="Build">
<a href="https://github.com/gopinathr143/go-collections/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-purple" alt="License"></a>
<img src="https://github.com/gopher-utils/go-collections/actions/workflows/build.yml/badge.svg" alt="Build">
<a href="https://github.com/gopher-utils/go-collections/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-purple" alt="License"></a>
</p>

Brings **L**anguage **In**tegrated **Q**uery features through basic collections into your go project.

**Features**:

<p>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; List datastructure of both primitive types and structs<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Set datastructure of both primitive types and structs<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Map datastructure of both primitive types and structs<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Sorting and searching of collections<br />
</p>
Basic collections with Go using generics.

## Table of Contents

Expand All @@ -25,7 +16,7 @@ Brings **L**anguage **In**tegrated **Q**uery features through basic collections
## Installation

```shell
go get github.com/gopinathr143/go-collections
go get github.com/gopher-utils/go-collections
```

## Usage
Expand All @@ -38,7 +29,7 @@ package main
import (
"fmt"

"github.com/gopinathr143/go-collections/collections/list"
"github.com/gopher-utils/go-collections/collections/list"
)

func main() {
Expand All @@ -63,7 +54,7 @@ func main() {

```

Please check the [documentation](https://pkg.go.dev/github.com/gopinathr143/go-collections) for more comprehensive usage.
Please check the [documentation](https://pkg.go.dev/github.com/gopher-utils/go-collections) for more comprehensive usage.

## Contributing

Expand Down
2 changes: 1 addition & 1 deletion go.mod
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
module github.com/gopinathr143/go-collections
module github.com/gopher-utils/go-collections

go 1.20

Expand Down
2 changes: 1 addition & 1 deletion list/list.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import (
"fmt"
"strings"

"github.com/gopinathr143/go-collections"
"github.com/gopher-utils/go-collections"
)

var (
Expand Down
4 changes: 2 additions & 2 deletions list/list_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ package list_test
import (
"testing"

"github.com/gopinathr143/go-collections"
"github.com/gopinathr143/go-collections/list"
"github.com/gopher-utils/go-collections"
"github.com/gopher-utils/go-collections/list"

"github.com/stretchr/testify/assert"
)
Expand Down
4 changes: 2 additions & 2 deletions math/basic_functions.go
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
package math

import (
"github.com/gopinathr143/go-collections"
"github.com/gopinathr143/go-collections/list"
"github.com/gopher-utils/go-collections"
"github.com/gopher-utils/go-collections/list"
)

// Returns the average of all elements present in the given collection.
Expand Down
4 changes: 2 additions & 2 deletions math/basic_functions_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ package math_test
import (
"testing"

"github.com/gopinathr143/go-collections/list"
"github.com/gopinathr143/go-collections/math"
"github.com/gopher-utils/go-collections/list"
"github.com/gopher-utils/go-collections/math"

"github.com/stretchr/testify/assert"
)
Expand Down

0 comments on commit 1d35847

Please sign in to comment.