First off, thank you for considering contributing to ETH-Transactions-Indexer. It's people like you that make the ETH-Transactions-Indexer better.
When contributing to ETH-Transactions-Indexer, 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.
If this is your first time contributing to the project, and you don't want to commit, there are other tasks you can do to be a hero:
- Review a Pull Request.
- Fix an Issue.
- Write a tutorial.
- Enhance the project's identity.
- Spread the project.
Have you noticed any bugs or have any feature requests? You can submit any request here.
It's generally best if you get confirmation of your bug or approval for your feature request this way before starting to code.
We use forking to contributing the project.
For more information, you can check this Git guide about forking.
If this is something you think you can fix, improve or add, then fork ETH-Transactions-Indexer and create a branch with a descriptive name.
A good branch name would be (where issue #123 is the issue you're working on):
git checkout -b 123-support-bitcoin-cash-rpc-apiBefore you start coding, you need to test if your project is running in your machine. Check out the README to warm up and set up the project.
At this point, you're ready to make your changes! Feel free to ask for help, everyone is a beginner at first.
At this point, you should switch back to your staging branch and make sure it's up to date with NodeChain's staging branch:
git remote add upstream
git checkout staging
git pull upstream stagingThen update your feature branch from your local copy of staging, and push it!
git checkout 123-issue-name
git rebase staging
git push --set-upstream origin 123-issue-nameFinally, go to GitHub and make a Pull Request 😄
If a maintainer asks you to "rebase" your PR, they're saying that a lot of code has changed, and that you need to update your branch so it's easier to merge.
To learn more about rebasing in Git, there are a lot of good resources as Github docs or Git-SCM docs, but here's the suggested workflow:
git checkout 123-issue-name
git pull --rebase upstream staging
git push --force-with-lease origin 123-issue-nameA PR can only be merged into staging by a maintainer if:
- It has been approved by at least two maintainers. If it was a maintainer who opened the PR, only one extra approval is needed.
- It has no requested changes.
- It is up to date with current staging.
A PR can only be merged from staging into master by a maintainer if:
- It is approved to move to the next production version by the rest of the maintainers.
- It has the documentation up to date.
- It is up to date with current master.
Any maintainer is allowed to merge a PR if all of these conditions are met.
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.
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.
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.
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.
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at [email protected]. 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.
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
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.
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.
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.
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.
This Code of Conduct is adapted from the Contributor Covenant, version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
Some text is adapted from the Contributing guidelines of Active Admin. Thanks for this amazing guide!