зеркало из https://github.com/golang/dep.git
Add COC and CONTRIBUTING.md
This commit is contained in:
Родитель
e59000375d
Коммит
44496d3cd8
|
@ -0,0 +1,74 @@
|
|||
# Contributor Covenant 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 sam (at) samboyer.org. 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/
|
|
@ -0,0 +1,40 @@
|
|||
# Contributing to `gps`
|
||||
|
||||
:+1::tada: First, we're thrilled you're thinking about contributing! :tada::+1:
|
||||
|
||||
As a library trying to cover all the bases in the Go package management space,
|
||||
it's crucial that we incorporate a broad range of experiences and use cases.
|
||||
There is a strong, motivating design behind `gps`, but we are always open to
|
||||
discussion on ways we can improve the library, particularly if it allows `gps`
|
||||
to cover more of the Go package management possibility space.
|
||||
|
||||
`gps` has no CLA, but we do have a [Code of Conduct](https://github.com/sdboyer/gps/blob/master/CODE_OF_CONDUCT.md). By
|
||||
participating, you are expected to uphold this code.
|
||||
|
||||
## How can I contribute?
|
||||
|
||||
It may be best to start by getting a handle on what `gps` actually is. Our
|
||||
wiki has a [general introduction](https://github.com/sdboyer/vsolver/wiki/Introduction-to-gps), a
|
||||
[guide for tool implementors](https://github.com/sdboyer/vsolver/wiki/gps-for-Implementors), and
|
||||
a [guide for contributors](https://github.com/sdboyer/vsolver/wiki/gps-for-contributors).
|
||||
There's also a [discursive essay](https://medium.com/@sdboyer/so-you-want-to-write-a-package-manager-4ae9c17d9527)
|
||||
that lays out the big-picture goals and considerations driving the `gps` design.
|
||||
|
||||
There are a number of ways to contribute, all highly valuable and deeply
|
||||
appreciated:
|
||||
|
||||
* Helping "translate" existing issues: as `gps` exits its larval stage, it still
|
||||
has a number of issues that may be incomprehensible to everyone except the
|
||||
author. Simply asking clarifying questions on these issues is helpful!
|
||||
* Identifying missed use cases: the loose `gps` rule of thumb is, "if you can do
|
||||
it in Go, we support it in `gps`." Posting issues about cases we've missed
|
||||
helps us reach that goal.
|
||||
Writing tests: in the same vein, `gps` has a [large suite](https://github.com/sdboyer/gps/blob/master/CODE_OF_CONDUCT.md) of solving tests, but
|
||||
they still only scratch the surface. Writing tests is not only helpful, but is
|
||||
also a great way to get a feel for how `gps` works.
|
||||
* Suggesting enhancements: `gps` has plenty of rough edges Help smooth them out!
|
||||
* Building experimental tools with `gps`: probably the best and fastest ways to
|
||||
kick the tires!
|
||||
|
||||
`gps` is still beta-ish software. APIs are subject to change (though they are
|
||||
stabilizing), and there are plenty of bugs to squash.
|
Загрузка…
Ссылка в новой задаче