From ac8e5f709430f84f588a1ae7e113904dddbf553f Mon Sep 17 00:00:00 2001 From: Aviv Carmi Date: Tue, 7 Mar 2023 10:34:48 +0200 Subject: [PATCH] update all docs and OSS policies --- CHANGELOG.md | 14 ++++ CODE_OF_CONDUCT.md | 133 +++++++++++++++++++++++++++++++++ CONTRIBUTING.md | 35 +++++++++ README.md | 47 +++++++++++- internal/README.md | 3 + internal/core/entity/README.md | 4 - internal/infra/README.md | 3 +- 7 files changed, 231 insertions(+), 8 deletions(-) create mode 100644 CHANGELOG.md create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md create mode 100644 internal/README.md delete mode 100644 internal/core/entity/README.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..f3b9d1f --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,14 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [[1.0.0](https://github.com/PerimeterX/go-project-structure/tree/v1.0.0)] - 2023-03-07 + +### Added + +- The full structure according to 2023-03-07 +- Documentation +- Examples diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..0f6c45e --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,133 @@ + +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, caste, color, religion, or sexual +identity and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the overall + community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or advances of + any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email address, + without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +[opensource-conduct@humansecurity.com](mailto:opensource-conduct@humansecurity.com). +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series of +actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or permanent +ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within the +community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.1, available at +[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. + +Community Impact Guidelines were inspired by +[Mozilla's code of conduct enforcement ladder][Mozilla CoC]. + +For answers to common questions about this code of conduct, see the FAQ at +[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at +[https://www.contributor-covenant.org/translations][translations]. + +[homepage]: https://www.contributor-covenant.org +[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html +[Mozilla CoC]: https://github.com/mozilla/diversity +[FAQ]: https://www.contributor-covenant.org/faq +[translations]: https://www.contributor-covenant.org/translations diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..5bbed79 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,35 @@ +# How To Contribute + +We'd love to accept your patches and contributions to this project. There are just a few guidelines you need to follow which are described in detail below. + +## 1. Fork this repo + +You should create a fork of this project in your account and work from there. You can create a fork by clicking the fork button in GitHub. + +## 2. One feature, one branch + +Work for each new feature/issue should occur in its own branch. To create a new branch from the command line: +```shell +git checkout -b my-new-feature +``` +where "my-new-feature" describes what you're working on. + +## 5. Add documentation and examples for new or updated functionality + +- Please review the [README.md](README.md) file in this project to see if they are impacted by your change and update them accordingly. +- If you've changed or added directories, make sure to provide or update their internal README file. +- Once finished, make sure to create a dedicated pull request in the example branch, updating according to your change. + +## 6. Add to CHANGELOG.md + +Any notable changes should be recorded in the CHANGELOG.md following the [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) conventions. + +## 7. Submit a pull request and describe the change + +Push your changes to your branch and open a pull request against the parent repo on GitHub. The project administrators will review your pull request and respond with feedback. + +# How your contribution gets merged + +Upon pull request submission, your code will be reviewed by the maintainers. They will confirm that contribution policy has been followed. + +A (human) reviewer will need to sign off on your pull request before it can be merged. diff --git a/README.md b/README.md index fd20af2..66e34a8 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,46 @@ -# go-project-structure +# Go Project Structure -TODO sum up once blog post is written +[![Go Reference](https://pkg.go.dev/badge/github.com/perimeterx/go-project-structure.svg)](https://pkg.go.dev/github.com/perimeterx/go-project-structure) +[![Licence](https://img.shields.io/github/license/perimeterx/go-project-structure)](LICENSE) +[![Latest Release](https://img.shields.io/github/v/release/perimeterx/go-project-structure)](https://github.com/perimeterx/go-project-structure/releases) +[![Issues](https://img.shields.io/github/issues/perimeterx/go-project-structure?logo=github)](https://github.com/perimeterx/go-project-structure/issues) +[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md) + +This is a template repository for Go projects. + +We released a blog post [TODO add link when ready] revealing the story behind this structure. +Our internal journey at HUMAN Security to find the best project structure, the decision we’ve taken, +and the conclusions we’ve drawn along the way. + +To view a full example, navigate to the [example branch](https://github.com/PerimeterX/go-project-structure/tree/example). + +Each of the directories in this repository contains a README file describing its purpose. + +## Contents + +- [Usage](#usage) +- [Project Structure Design](#project-structure-design) +- [Contact and Contribute](#contact-and-contribute) + +## Usage + +To create a new project, fork this repository or [use it as a template repository](https://github.com/PerimeterX/go-project-structure/generate). + +## Project Structure Design + +The project structure is designed with [independent packages](https://medium.com/@avivcarmis/ok-lets-go-three-approaches-to-structuring-go-code-42e2370c3ae5#92df) in mind, +according to [hexagonal architecture](https://en.wikipedia.org/wiki/Hexagonal_architecture_(software)), and targeted to provide the following benefits: +- Structural coherence +- Separation of business logic and infrastructure +- Reusability +- Dependency declaration + +Fore more info, read the full article behind this structure [TODO add link when ready]. + +## Contact and Contribute + +Reporting issues and requesting features may be done in our [GitHub issues page](https://github.com/PerimeterX/go-project-structure/issues). +For any further questions or comments you can reach us out at [open-source@humansecurity.com](mailto:open-source@humansecurity.com). + +Any type of contribution is warmly welcome and appreciated ❤️ +Please read our [contribution](CONTRIBUTING.md) guide for more info. diff --git a/internal/README.md b/internal/README.md new file mode 100644 index 0000000..fdd4381 --- /dev/null +++ b/internal/README.md @@ -0,0 +1,3 @@ +# `/internal` + +Contains code and packages we do not wish to share with other repositories and projects. diff --git a/internal/core/entity/README.md b/internal/core/entity/README.md deleted file mode 100644 index 374764b..0000000 --- a/internal/core/entity/README.md +++ /dev/null @@ -1,4 +0,0 @@ -# `/entity` - -Entities that must be shared between several core packages -but should not be visible outside the repo should be placed here. diff --git a/internal/infra/README.md b/internal/infra/README.md index 6e40b3c..e3dfbfe 100644 --- a/internal/infra/README.md +++ b/internal/infra/README.md @@ -1,4 +1,3 @@ # `/infra` -Contains the infrastructure layer of the project, -divided to packages by technologies or infra domains. +Contains the infrastructure layer of the project, divided to packages by technologies or infra domains.