Skip to content

Latest commit

 

History

History
65 lines (34 loc) · 3.17 KB

CONTRIBUTING.md

File metadata and controls

65 lines (34 loc) · 3.17 KB

Contributing to Outp0st

Our vision for Outp0st is for it to become the trusted standard toolbox (read: UX layer) for the open source contracts infrastructure landscape. Think of it like Kubernetes for developer experience or CMS-like interface for blockchain entrepreneurs. We realize this is an ambitious goal. We can’t do it alone.

Therefore we want to create a strong community of contributors -- all working together to create the kind of delightful experience that our developers deserve.

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given. ❤️

Outp0st is released under the Apache 2.0 License, and original creations contributed to this repo are accepted under the same license.

A lot of this vision, open source techniques and texts are inspired by amazing work of backstage.io team, please leave a star on thier repo.

Types of Contributions

Report bugs

No one likes bugs. Report bugs as an issue here.

Fix bugs or build new features

Look through the GitHub issues for bugs, good first issues or help wanted.

Adding Non-code Contributions

Since there is such a large landscape of possible development, build, and deployment environments, we welcome community contributions in these areas in the /contrib folder of the project. This is an excellent place to put things that help out the community at large, but which may not fit within the scope of the core product to support natively.

Write Documentation

The current documentation is very limited. Help us make the apps/web/docs folder come alive.

Submit Feedback

The best way to send feedback is to file an issue.

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Use appropriate labels
  • Remember that this is a volunteer-driven project, and that contributions are welcome :)

Add your company to ADOPTERS

Have you started using Backstage? Adding your company to ADOPTERS really helps the project.

Get Started!

So...feel ready to jump in? Let's do this. 👏🏻💯

Start by reading our Getting Started for Contributors page to get yourself setup with a fresh copy of outp0st ready for your contributions. If you need help, just jump into our Discord chatroom.

Coding Guidelines

All code is formatted with prettier using the configuration in the repo. If possible we recommend configuring your editor to format automatically, you can add PR to add automatic formatting using packages/config/prettier.config.js for prettier

Code of Conduct

Security Issues?

See SECURITY.