mirror of
https://github.com/ethereum/go-ethereum.git
synced 2026-08-20 10:52:25 +00:00
Add .github
This commit is contained in:
parent
412d857322
commit
41282cc246
5 changed files with 154 additions and 56 deletions
109
.github/CONTRIBUTING.md
vendored
109
.github/CONTRIBUTING.md
vendored
|
|
@ -1,40 +1,89 @@
|
||||||
# Contributing
|
# Contributing
|
||||||
|
|
||||||
Thank you for considering to help out with the source code! We welcome
|
When contributing to this repository, please first discuss the change you wish to make via issue,
|
||||||
contributions from anyone on the internet, and are grateful for even the
|
email, or any other method with the owners of this repository before making a change.
|
||||||
smallest of fixes!
|
|
||||||
|
|
||||||
If you'd like to contribute to go-ethereum, please fork, fix, commit and send a
|
Please note we have a code of conduct, please follow it in all your interactions with the project.
|
||||||
pull request for the maintainers to review and merge into the main code base. If
|
|
||||||
you wish to submit more complex changes though, please check up with the core
|
|
||||||
devs first on [our gitter channel](https://gitter.im/ethereum/go-ethereum) to
|
|
||||||
ensure those changes are in line with the general philosophy of the project
|
|
||||||
and/or get some early feedback which can make both your efforts much lighter as
|
|
||||||
well as our review and merge procedures quick and simple.
|
|
||||||
|
|
||||||
## Coding guidelines
|
## Pull Request Process
|
||||||
|
|
||||||
Please make sure your contributions adhere to our coding guidelines:
|
1. Ensure that tests pass and code is lint free: `npm test`
|
||||||
|
2. Update the README.md if any changes invalidate its current content.
|
||||||
|
3. Include any tests for new functionality.
|
||||||
|
4. Reference any revelant issues in your PR comment.
|
||||||
|
|
||||||
* Code must adhere to the official Go
|
## Code of Conduct
|
||||||
[formatting](https://golang.org/doc/effective_go.html#formatting) guidelines
|
|
||||||
(i.e. uses [gofmt](https://golang.org/cmd/gofmt/)).
|
|
||||||
* Code must be documented adhering to the official Go
|
|
||||||
[commentary](https://golang.org/doc/effective_go.html#commentary) guidelines.
|
|
||||||
* Pull requests need to be based on and opened against the `master` branch.
|
|
||||||
* Commit messages should be prefixed with the package(s) they modify.
|
|
||||||
* E.g. "eth, rpc: make trace configs optional"
|
|
||||||
|
|
||||||
## Can I have feature X
|
### Our Pledge
|
||||||
|
|
||||||
Before you submit a feature request, please check and make sure that it isn't
|
In the interest of fostering an open and welcoming environment, we as
|
||||||
possible through some other means. The JavaScript-enabled console is a powerful
|
contributors and maintainers pledge to making participation in our project and
|
||||||
feature in the right hands. Please check our
|
our community a harassment-free experience for everyone, regardless of age, body
|
||||||
[Wiki page](https://github.com/ethereum/go-ethereum/wiki) for more info
|
size, disability, ethnicity, gender identity and expression, level of experience,
|
||||||
and help.
|
nationality, personal appearance, race, religion, or sexual identity and
|
||||||
|
orientation.
|
||||||
|
|
||||||
## Configuration, dependencies, and tests
|
### Our Standards
|
||||||
|
|
||||||
Please see the [Developers' Guide](https://github.com/ethereum/go-ethereum/wiki/Developers'-Guide)
|
Examples of behavior that contributes to creating a positive environment
|
||||||
for more details on configuring your environment, managing project dependencies
|
include:
|
||||||
and testing procedures.
|
|
||||||
|
* 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 contributing@plasma.group. 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] and from the [Angular Seed Contributing Guide][angular-contrib].
|
||||||
|
|
||||||
|
[homepage]: http://contributor-covenant.org
|
||||||
|
[version]: http://contributor-covenant.org/version/1/4/
|
||||||
|
[angular-contrib]: https://github.com/mgechev/angular-seed/blob/master/.github/CONTRIBUTING.md
|
||||||
26
.github/ISSUE_TEMPLATE.md
vendored
26
.github/ISSUE_TEMPLATE.md
vendored
|
|
@ -1,26 +0,0 @@
|
||||||
Hi there,
|
|
||||||
|
|
||||||
Please note that this is an issue tracker reserved for bug reports and feature requests.
|
|
||||||
|
|
||||||
For general questions please use the gitter channel or the Ethereum stack exchange at https://ethereum.stackexchange.com.
|
|
||||||
|
|
||||||
#### System information
|
|
||||||
|
|
||||||
Geth version: `geth version`
|
|
||||||
OS & Version: Windows/Linux/OSX
|
|
||||||
Commit hash : (if `develop`)
|
|
||||||
|
|
||||||
#### Expected behaviour
|
|
||||||
|
|
||||||
|
|
||||||
#### Actual behaviour
|
|
||||||
|
|
||||||
|
|
||||||
#### Steps to reproduce the behaviour
|
|
||||||
|
|
||||||
|
|
||||||
#### Backtrace
|
|
||||||
|
|
||||||
````
|
|
||||||
[backtrace]
|
|
||||||
````
|
|
||||||
31
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
31
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
|
|
@ -0,0 +1,31 @@
|
||||||
|
---
|
||||||
|
name: Bug report
|
||||||
|
about: Create a report to help us improve
|
||||||
|
title: ''
|
||||||
|
labels: ''
|
||||||
|
assignees: ''
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**Describe the bug**
|
||||||
|
A clear and concise description of the bug.
|
||||||
|
|
||||||
|
**Steps to reproduce**
|
||||||
|
Steps to reproduce the behavior:
|
||||||
|
1.
|
||||||
|
2.
|
||||||
|
3.
|
||||||
|
|
||||||
|
**Expected behavior**
|
||||||
|
A clear and concise description of what you expected to happen.
|
||||||
|
|
||||||
|
**Screenshots**
|
||||||
|
If applicable, add screenshots to help explain your problem.
|
||||||
|
|
||||||
|
**Specifications**
|
||||||
|
- Version:
|
||||||
|
- OS:
|
||||||
|
- Node Version:
|
||||||
|
|
||||||
|
**Additional context**
|
||||||
|
Add any other context about the problem here.
|
||||||
20
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
20
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
|
|
@ -0,0 +1,20 @@
|
||||||
|
---
|
||||||
|
name: Feature request
|
||||||
|
about: Suggest an idea for this project
|
||||||
|
title: ''
|
||||||
|
labels: ''
|
||||||
|
assignees: ''
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**Is your feature request related to a problem? Please describe.**
|
||||||
|
A clear and concise description of what the problem is.
|
||||||
|
|
||||||
|
**Describe the solution you'd like**
|
||||||
|
A clear and concise description of what you want to happen.
|
||||||
|
|
||||||
|
**Describe alternatives you've considered**
|
||||||
|
A clear and concise description of any alternative solutions or features you've considered.
|
||||||
|
|
||||||
|
**Additional context**
|
||||||
|
Add any other context or screenshots about the feature request here.
|
||||||
24
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
24
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
|
|
@ -0,0 +1,24 @@
|
||||||
|
## Description
|
||||||
|
|
||||||
|
## Questions
|
||||||
|
-
|
||||||
|
-
|
||||||
|
-
|
||||||
|
|
||||||
|
## Metadata
|
||||||
|
### Fixes
|
||||||
|
- Fixes # [Link to Issue]
|
||||||
|
- Fixes # [Link to Issue]
|
||||||
|
- Fixes # [Link to Issue]
|
||||||
|
|
||||||
|
### Blockers
|
||||||
|
- #
|
||||||
|
- #
|
||||||
|
- #
|
||||||
|
|
||||||
|
## Contributing Agreement
|
||||||
|
<!--
|
||||||
|
You *must* read and fully understand our Contributing Guide and Code of Conduct before submitting this pull request. Strong, healthy, and respectful communities are the best way to build great code 💖.
|
||||||
|
-->
|
||||||
|
|
||||||
|
- [ ] I have read and understood the [Plasma Group Contributing Guide and Code of Conduct](https://github.com/plasma-group/pigi/blob/master/.github/CONTRIBUTING.md) and am following those guidelines in this pull request.
|
||||||
Loading…
Reference in a new issue