mirror of https://github.com/gobeam/stringy.git
Roshan Ranabhat
GitHub
commit
97d88d29a6
|
|
@ -0,0 +1,76 @@
|
|||
# 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, sex characteristics, gender identity and expression,
|
||||
level of experience, education, socio-economic status, 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 roshanranabhat11@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 https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
|
||||
|
||||
[homepage]: https://www.contributor-covenant.org
|
||||
|
||||
For answers to common questions about this code of conduct, see
|
||||
https://www.contributor-covenant.org/faq
|
||||
|
|
@ -0,0 +1,58 @@
|
|||
# Contributing to Transcriptase
|
||||
We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
|
||||
|
||||
- Reporting a bug
|
||||
- Discussing the current state of the code
|
||||
- Submitting a fix
|
||||
- Proposing new features
|
||||
- Becoming a maintainer
|
||||
|
||||
## Any contributions you make will be under the MIT Software License
|
||||
In short, when you submit code changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if that's a concern.
|
||||
|
||||
## Report bugs using Github's [issues](https://github.com/gobeam/stringy/issues)
|
||||
|
||||
A relevant coding style guideline is the [Go Code Review Comments](https://code.google.com/p/go-wiki/wiki/CodeReviewComments).
|
||||
|
||||
Documentation
|
||||
-------------
|
||||
|
||||
If you contribute anything that changes the behavior of the application,
|
||||
document it in the follow places as applicable:
|
||||
* the code itself, through clear comments and unit tests
|
||||
* [README](README.md)
|
||||
|
||||
This includes new features, additional variants of behavior, and breaking
|
||||
changes.
|
||||
|
||||
Testing
|
||||
-------
|
||||
|
||||
Tests are written using golang's standard testing tools, and are run prior to
|
||||
the PR being accepted.
|
||||
|
||||
Issues
|
||||
------
|
||||
|
||||
For creating an issue:
|
||||
* **Bugs:** please be as thorough as possible, with steps to recreate the issue
|
||||
and any other relevant information.
|
||||
* **Feature Requests:** please include functionality and use cases. If this is
|
||||
an extension of a current feature, please include whether or not this would
|
||||
be a breaking change or how to extend the feature with backwards
|
||||
compatibility.
|
||||
* **Security Vulnerability:** please report it at
|
||||
https://my.xfinity.com/vulnerabilityreport and contact the [maintainers](MAINTAINERS.md).
|
||||
|
||||
If you wish to work on an issue, please assign it to yourself. If you have any
|
||||
questions regarding implementation, feel free to ask clarifying questions on
|
||||
the issue itself.
|
||||
|
||||
Pull Requests
|
||||
-------------
|
||||
|
||||
* should be narrowly focused with no more than 3 or 4 logical commits
|
||||
* when possible, address no more than one issue
|
||||
* should be reviewable in the GitHub code review tool
|
||||
* should be linked to any issues it relates to (i.e. issue number after (#) in commit messages or pull request message)
|
||||
* should conform to idiomatic golang code formatting
|
||||
|
|
@ -0,0 +1,32 @@
|
|||
# Description
|
||||
|
||||
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
|
||||
|
||||
Fixes # (issue)
|
||||
|
||||
## Type of change
|
||||
|
||||
Please delete options that are not relevant.
|
||||
|
||||
- [ ] Bug fix (non-breaking change which fixes an issue)
|
||||
- [ ] New feature (non-breaking change which adds functionality)
|
||||
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
|
||||
- [ ] This change requires a documentation update
|
||||
|
||||
# How Has This Been Tested?
|
||||
|
||||
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
|
||||
|
||||
- [ ] Test A
|
||||
- [ ] Test B
|
||||
|
||||
# Checklist:
|
||||
|
||||
- [ ] My code follows the style guidelines of this project
|
||||
- [ ] I have performed a self-review of my own code
|
||||
- [ ] I have commented my code, particularly in hard-to-understand areas
|
||||
- [ ] I have made corresponding changes to the documentation
|
||||
- [ ] My changes generate no new warnings
|
||||
- [ ] I have added tests that prove my fix is effective or that my feature works
|
||||
- [ ] New and existing unit tests pass locally with my changes
|
||||
- [ ] Any dependent changes have been merged and published in downstream modules
|
||||
|
|
@ -342,7 +342,7 @@ $ go test
|
|||
## Contributing
|
||||
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
|
||||
|
||||
Please make sure to update tests as appropriate.
|
||||
Please make sure to update tests as appropriate. - see `CONTRIBUTING.md` for details.
|
||||
|
||||
|
||||
## License
|
||||
|
|
@ -350,8 +350,8 @@ Please make sure to update tests as appropriate.
|
|||
Released under the MIT License - see `LICENSE.txt` for details.
|
||||
|
||||
|
||||
[Build-Status-Url]: https://travis-ci.org/gobeam/stringy
|
||||
[Build-Status-Image]: https://travis-ci.org/gobeam/stringy.svg?branch=master
|
||||
[Build-Status-Url]: https://travis-ci.com/gobeam/stringy
|
||||
[Build-Status-Image]: https://travis-ci.com/gobeam/stringy.svg?branch=master
|
||||
[godoc-url]: https://pkg.go.dev/github.com/gobeam/stringy?tab=doc
|
||||
[godoc-image]: https://godoc.org/github.com/gobeam/stringy?status.svg
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue