From 9af2f6486c45bdf5298a2bab4cf09dae97e7b351 Mon Sep 17 00:00:00 2001 From: Ruidy Nemausat Date: Wed, 20 Oct 2021 17:22:24 +0200 Subject: [PATCH] docs: add more --- CONTRIBUTING.md | 78 +++++++++++++++++++++++++++++++++++++ LICENSE.md | 16 ++++++++ README.md | 96 ++++++++++++++++++++++++++++++++++++++++++++++ cmd/root.go | 2 + passGen/passGen.go | 1 + 5 files changed, 193 insertions(+) create mode 100644 CONTRIBUTING.md create mode 100644 LICENSE.md create mode 100644 README.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..03b3e7a --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,78 @@ +# Contributing + +When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other +method with the owners of this repository before making a change. + +Please note we have a code of conduct, please follow it in all your interactions with the project. + +## Pull Request Process + +1. Be sure to remove any install or build dependencies before the end of the layer when doing a build. +2. Update the README.md with details of changes to the interface, this includes new environment variables, exposed + ports, useful file locations and container parameters. +3. Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would + represent. The versioning scheme we use is [SemVer](http://semver.org/). +4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have + permission to do that, you may request the second reviewer to merge it for you. + +## Code of Conduct + +### Our Pledge + +In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making +participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, +disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, +religion, or sexual identity and orientation. + +### Our Standards + +Examples of behavior that contributes to creating a positive environment include: + +- Using welcoming and inclusive language +- Being respectful of differing viewpoints and experiences +- Gracefully accepting constructive criticism +- Focusing on what is best for the community +- Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +- The use of sexualized language or imagery and unwelcome sexual attention or advances +- Trolling, insulting/derogatory comments, and personal or political attacks +- Public or private harassment +- Publishing others' private information, such as a physical or electronic address, without explicit permission +- Other conduct which could reasonably be considered inappropriate in a professional setting + +### Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take +appropriate and fair corrective action in response to any instances of unacceptable behavior. + +Project maintainers 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, or to ban temporarily or permanently any +contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. + +### Scope + +This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the +project or its community. Examples of representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed representative at an online or offline +event. Representation of a project may be further defined and clarified by project maintainers. + +### Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team +at [ruidy.nemausat@gmail.com]. All complaints will be reviewed and investigated and will result in a response that is +deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with +regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent +repercussions as determined by other members of the project's leadership. + +### Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available +at [http://contributor-covenant.org/version/1/4][version] + +[homepage]: http://contributor-covenant.org + +[version]: http://contributor-covenant.org/version/1/4/ \ No newline at end of file diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..314aaa4 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,16 @@ +# MIT License + +Copyright (c) [2021] [Ruidy] + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated +documentation files (the "Software"), to deal in the Software without restriction, including without limitation the +rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit +persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the +Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE +WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR +COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR +OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..4e49616 --- /dev/null +++ b/README.md @@ -0,0 +1,96 @@ +# 🍉 PassGen + +Simple password generator. + +## Getting Started + +These instructions will get you a copy of the project up and running on your local machine for development and testing +purposes. See deployment for notes on how to deploy the project on a live system. + +More documentation: + +```shell +godoc -http=:6060 +open http://localhost:6060/pkg/github.com/rjNemo/go-pass-gen/ +``` + +### Prerequisites + +- Install a recent Golang version on the [official website](https://golang.org/doc/install). +- Install `air` to enable auto reload during development using : + +```shell +curl -sSfL https://raw.githubusercontent.com/cosmtrek/air/master/install.sh | sh -s -- -b $(go env GOPATH)/bin +``` + +Then initialize it in the project directory with: + +```shell +air init +``` + +### Installing + +Install dependencies using: + +```shell +go mod tidy +``` + +Run the development server with: + +```shell +air +``` + +## Running the tests + +Explain how to run the automated tests for this system + +### Break down into end to end tests + +Explain what these tests test and why + +```shell script +Give an example +``` + +### And coding style tests + +Explain what these tests test and why + +```shell script +Give an example +``` + +## Deployment + +[Quality check](https://goreportcard.com/) before deployment. + +## Built With + +| Tool | Description | +| ------------------------------------------ | --------------------------------------------------------------------------------------------------------------- | +| [Go](https://golang.org/) | Go is an open source programming language that makes it easy to build simple, reliable, and efficient software. | +| [Cobra](https://cobra.dev/) | A Framework for Modern CLI Apps in Go | + +## Contributing + +Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull +requests to us. + +## Versioning + +We use [SemVer](http://semver.org/) for versioning. For the versions available, see +the [tags on this repository](https://github.com/rjNemo/go-pass-gen/tags). + +## Authors + +- **Ruidy** - _Initial work_ - [Ruidy](https://github.com/rjNemo) + +See also the list of [contributors](https://github.com/rjNemo/go-pass-gen/contributors) who participated in this +project. + +## License + +This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details diff --git a/cmd/root.go b/cmd/root.go index 796cb6f..04dc00b 100644 --- a/cmd/root.go +++ b/cmd/root.go @@ -1,3 +1,4 @@ +// Package cmd defines the command-line interface to passGen package cmd import ( @@ -16,6 +17,7 @@ var rootCommand = &cobra.Command{ }, } +// Execute is where the fun actually happens. func Execute() { if err := rootCommand.Execute(); err != nil { log.Println(err) diff --git a/passGen/passGen.go b/passGen/passGen.go index 380052a..6a8bd76 100644 --- a/passGen/passGen.go +++ b/passGen/passGen.go @@ -1,3 +1,4 @@ +// Package passGen creates a random password. package passGen import (