diff --git a/docs/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md similarity index 100% rename from docs/CODE_OF_CONDUCT.md rename to CODE_OF_CONDUCT.md diff --git a/docs/CONTRIBUTING.md b/CONTRIBUTING.md similarity index 71% rename from docs/CONTRIBUTING.md rename to CONTRIBUTING.md index e9ef7c22b..45b44cb8a 100644 --- a/docs/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,7 +7,7 @@ Please read and follow the guidelines below. ## Communication -* Before starting work on a major feature, please reach out to us via [GitHub](https://github.com/kubeshark/kubeshark), [Slack](https://join.slack.com/share/zt-u6bbs3pg-X1zhQOXOH0yEoqILgH~csw), [email](mailto:kubeshark@up9.com), etc. We will make sure no one else is already working on it. A _major feature_ is defined as any change that is > 100 LOC altered (not including tests), or changes any user-facing behavior +* Before starting work on a major feature, please reach out to us via [GitHub](https://github.com/kubeshark/kubeshark), [Discord](https://discord.gg/WkvRGMUcx7), [Slack](https://join.slack.com/t/kubeshark/shared_invite/zt-1k3sybpq9-uAhFkuPJiJftKniqrGHGhg), [email](mailto:info@kubeshark.co), etc. We will make sure no one else is already working on it. A _major feature_ is defined as any change that is > 100 LOC altered (not including tests), or changes any user-facing behavior * Small patches and bug fixes don't need prior communication. ## Contribution Requirements diff --git a/README.md b/README.md index ba0ca6229..53316f841 100644 --- a/README.md +++ b/README.md @@ -103,8 +103,8 @@ The documentation resources are open-source and can be found on GitHub: [kubesha ## Contributing -We ❤️ pull requests! See [CONTRIBUTING.md](docs/CONTRIBUTING.md) for the contribution guide. +We ❤️ pull requests! See [CONTRIBUTING.md](CONTRIBUTING.md) for the contribution guide. ## Code of Conduct -This project is for everyone. We ask that our users and contributors take a few minutes to review our [Code of Conduct](docs/CODE_OF_CONDUCT.md). +This project is for everyone. We ask that our users and contributors take a few minutes to review our [Code of Conduct](CODE_OF_CONDUCT.md). diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md deleted file mode 100644 index 1e02739c9..000000000 --- a/docs/CHANGELOG.md +++ /dev/null @@ -1 +0,0 @@ -Kubeshark CHANGELOG is now part of [Kubeshark wiki](https://github.com/kubeshark/kubeshark/wiki/CHANGELOG) diff --git a/docs/CODEOWNERS b/docs/CODEOWNERS deleted file mode 100644 index 694076f95..000000000 --- a/docs/CODEOWNERS +++ /dev/null @@ -1,4 +0,0 @@ -# This is a comment. -# Each line is a file pattern followed by one or more owners. - -/ui/ @frontend diff --git a/docs/TESTING.md b/docs/TESTING.md deleted file mode 100644 index 4fbef1d05..000000000 --- a/docs/TESTING.md +++ /dev/null @@ -1,20 +0,0 @@ - -# Testing guidelines - -## Generic guidelines -* Use "[testing](https://pkg.go.dev/testing)" package -* Write [Table-driven tests using subtests](https://go.dev/blog/subtests) -* Use cleanup in test/subtest in order to clean up resources -* Name the test func "Test<tested_func_name><tested_case>" - -## Unit tests -* Position the test file inside the folder of the tested package -* In case of internal func testing - * Name the test file "<tested_file_name>_internal_test.go" - * Name the test package same as the package being tested - * Example - [Config](../cli/config/config_internal_test.go) -* In case of exported func testing - * Name the test file "<tested_file_name>_test.go" - * Name the test package "<tested_package>_test" - * Example - [Slice Utils](../cli/kubeshark/sliceUtils_test.go) -* Make sure to run test coverage to make sure you covered all the cases and lines in the func