-
Notifications
You must be signed in to change notification settings - Fork 19
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Pull docs structure from py-evm, move README contributing info into docs
- Loading branch information
Showing
12 changed files
with
313 additions
and
144 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| 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, | ||
| 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 snakecharmers@ethereum.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 <https://www.contributor-covenant.org>`_, version 1.4, | ||
| available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,164 @@ | ||
| Contributing | ||
| ------------ | ||
|
|
||
| Thank you for your interest in contributing! We welcome all contributions no matter | ||
| their size. Please read along to learn how to get started. If you get stuck, feel free | ||
| to ask for help in `Ethereum Python Discord server <https://discord.gg/GHryRvPB84>`_. | ||
|
|
||
| Setting the stage | ||
| ~~~~~~~~~~~~~~~~~ | ||
|
|
||
| To get started, fork the repository to your own github account, then clone it to your | ||
| development machine: | ||
|
|
||
| .. code:: sh | ||
| git clone git@github.com:your-github-username/hexbytes.git | ||
| Next, install the development dependencies. We recommend using a virtual environment, | ||
| such as `virtualenv <https://virtualenv.pypa.io/en/stable/>`_. | ||
|
|
||
| .. code:: sh | ||
| cd hexbytes | ||
| virtualenv -p python venv | ||
| . venv/bin/activate | ||
| python -m pip install -e ".[dev]" | ||
| pre-commit install | ||
| Running the tests | ||
| ~~~~~~~~~~~~~~~~~ | ||
|
|
||
| A great way to explore the code base is to run the tests. | ||
|
|
||
| We can run all tests with: | ||
|
|
||
| .. code:: sh | ||
| pytest tests | ||
| Code Style | ||
| ~~~~~~~~~~ | ||
|
|
||
| We use `pre-commit <https://pre-commit.com/>`_ to enforce a consistent code style across | ||
| the library. This tool runs automatically with every commit, but you can also run it | ||
| manually with: | ||
|
|
||
| .. code:: sh | ||
| make lint | ||
| If you need to make a commit that skips the ``pre-commit`` checks, you can do so with | ||
| ``git commit --no-verify``. | ||
|
|
||
| This library uses type hints, which are enforced by the ``mypy`` tool (part of the | ||
| ``pre-commit`` checks). All new code is required to land with type hints, with the | ||
| exception of code within the ``tests`` directory. | ||
|
|
||
| Documentation | ||
| ~~~~~~~~~~~~~ | ||
|
|
||
| Good documentation will lead to quicker adoption and happier users. Please check out our | ||
| guide on | ||
| `how to create documentation for the Python Ethereum ecosystem <https://github.com/ethereum/snake-charmers-tactical-manual/blob/main/documentation.md>`_. | ||
|
|
||
| Pull Requests | ||
| ~~~~~~~~~~~~~ | ||
|
|
||
| It's a good idea to make pull requests early on. A pull request represents the start of | ||
| a discussion, and doesn't necessarily need to be the final, finished submission. | ||
|
|
||
| GitHub's documentation for working on pull requests is | ||
| `available here <https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests>`_. | ||
|
|
||
| Once you've made a pull request take a look at the Circle CI build status in the | ||
| GitHub interface and make sure all tests are passing. In general pull requests that | ||
| do not pass the CI build yet won't get reviewed unless explicitly requested. | ||
|
|
||
| If the pull request introduces changes that should be reflected in the release notes, | ||
| please add a `newsfragment` file as explained | ||
| `here <https://github.com/ethereum/hexbytes/blob/main/newsfragments/README.md>`_. | ||
|
|
||
| If possible, the change to the release notes file should be included in the commit that | ||
| introduces the feature or bugfix. | ||
|
|
||
| Releasing | ||
| ~~~~~~~~~ | ||
|
|
||
| Releases are typically done from the ``main`` branch, except when releasing a beta (in | ||
| which case the beta is released from ``main``, and the previous stable branch is | ||
| released from said branch). | ||
|
|
||
| Final test before each release | ||
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
|
|
||
| Before releasing a new version, build and test the package that will be released: | ||
|
|
||
| .. code:: sh | ||
| git checkout main && git pull | ||
| make package-test | ||
| This will build the package and install it in a temporary virtual environment. Follow | ||
| the instructions to activate the venv and test whatever you think is important. | ||
|
|
||
| You can also preview the release notes: | ||
|
|
||
| .. code:: sh | ||
| towncrier --draft | ||
| Build the release notes | ||
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
|
|
||
| Before bumping the version number, build the release notes. You must include the part of | ||
| the version to bump (see below), which changes how the version number will show in the | ||
| release notes. | ||
|
|
||
| .. code:: sh | ||
| make notes bump=$$VERSION_PART_TO_BUMP$$ | ||
| If there are any errors, be sure to re-run make notes until it works. | ||
|
|
||
| Push the release to github & pypi | ||
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
|
|
||
| After confirming that the release package looks okay, release a new version: | ||
|
|
||
| .. code:: sh | ||
| make release bump=$$VERSION_PART_TO_BUMP$$ | ||
| This command will: | ||
|
|
||
| - Bump the version number as specified in ``.pyproject.toml`` and ``setup.py``. | ||
| - Create a git commit and tag for the new version. | ||
| - Build the package. | ||
| - Push the commit and tag to github. | ||
| - Push the new package files to pypi. | ||
|
|
||
| Which version part to bump | ||
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
|
|
||
| ``$$VERSION_PART_TO_BUMP$$`` must be one of: ``major``, ``minor``, ``patch``, ``stage``, | ||
| or ``devnum``. | ||
|
|
||
| The version format for this repo is ``{major}.{minor}.{patch}`` for stable, and | ||
| ``{major}.{minor}.{patch}-{stage}.{devnum}`` for unstable (``stage`` can be alpha or | ||
| beta). | ||
|
|
||
| If you are in a beta version, ``make release bump=stage`` will switch to a stable. | ||
|
|
||
| To issue an unstable version when the current version is stable, specify the new version | ||
| explicitly, like ``make release bump="--new-version 4.0.0-alpha.1"`` | ||
|
|
||
| You can see what the result of bumping any particular version part would be with | ||
| ``bump-my-version show-bump`` |
Oops, something went wrong.