Welcome to the NEO•ONE community! We’re always looking for more contributors and are happy to have you. This document should help make the process for contributing clear and answer some questions that you may have.
Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved.
Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.
NEO•ONE is an open source project and we love to receive contributions from our community — you! There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests or writing code which can be incorporated into NEO•ONE itself.
Please, don’t use the issue tracker for support questions. The Help section is the best place to start for getting support.
Well-written bug reports with consistently reproducible steps are invaluable to the development of NEO•ONE. Bugs are tracked as GitHub issues. Before creating an issue, please perform a search to see if the problem has already been reported. After you’ve determined a bug does not already exist, create an issue and fill in the template.
Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and aims of the project. It’s up to you to make a strong case to convince the project’s developers of the merits of this feature. Please provide as much detail and context as possible.
npm install -g @microsoft/rush.
git clone https://github.com/neo-one-suite/neo-one.git.
rush installto install the dependencies.
rush buildto build the packages. Rush will perform an "incremental build", which means that it will only build packages whose source files have changed since the last successful build and the packages that depend on those packages.
rush buildbefore running E2E tests or trying to run a bin.
rush test. To run all the E2E tests run
rush test -tor
rush e2e -t.
neo-one-client-commonyou would run
rush test -t packages/neo-one-client-common/src/__tests__/**/*
rush build. Then, to start the CLI you’d run
node packages/neo-one-cli/bin/neo-one.jsfrom inside the NEO•ONE repository. You will then be running the new NEO•ONE CLI with your changes. From there you can see your new code directly in action.
Unsure where to begin contributing to NEO•ONE? Here are some great ways to get started:
Once you’ve had your first pull request approved and merged, find existing issues marked with help wanted labels to continue contributing or suggest an enhancement. Respond on the issue thread expressing interest in working on it. This helps other people know that the issue is active, and hopefully prevents duplicated efforts.
By contributing to NEO•ONE, you agree that your contributions will be licensed under its MIT license.