Contributing

Basic steps to get started

• Fork the Stacks UI repository on Github.
• Clone your fork to your local machine git clone git@github.com:<yourname>/ui.git
• Create a branch git checkout -b feature/my-feature-branch
• Run yarn to install all of the dependencies.
• Make sure you're working in either packages/* or docs to contribute to these projects.
• Make your changes, run yarn lint, then push to to GitHub with git push --set-upstream origin feature/my-feature-branch.
• Visit GitHub and make your pull request.

git remote add upstream git@github.com:blockstack/ui.git
git checkout master
git pull upstream master
git checkout -b feature/my-feature-branchgit remote add upstream git@github.com:blockstack/ui.gitgit checkout mastergit pull upstream mastergit checkout -b feature/my-feature-branch

Locally testing the UI library

To view your changes in a live environment, we have a test application within the monorepo found in the folder named example that always uses whatever code is in the packages/ui directory. This is possible because most of the projects in the monorepo are linked together via a tsconfig.json paths configuration. To run the test app, navigate to example and run yarn dev.

Additionally, when you open up a PR, the Stacks UI package will be built and deployed within the CodeSandbox CI tool, giving you the ability to test out the changes in a sharable manner.

Usage

Next.js has a development mode that uses Fast Refresh to automatically reload the site as you make changes. To start the dev mode, simply run:

cd docs && yarn devcd docs && yarn dev

You can now access the documentation site locally.

Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make 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 within all project spaces, and it also applies when an individual is representing the project or its community in public spaces. 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 design@blockstack.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, version 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

For answers to common questions about this code of conduct, see https://www.contributor-covenant.org/faq