Skip to content

Latest commit

 

History

History
27 lines (18 loc) · 1.68 KB

CONTRIBUTING.md

File metadata and controls

27 lines (18 loc) · 1.68 KB
Raw

Contribute to Frontity

We really appreciate your interest to contribute to Frontity! Any kind of contribution is highly appreciated, not only coding ☺️.

Coding Contributions

There is a detailed guide about how to contribute coding at our docs: Code Contributions, but if you are looking for a quick guide, these are the main steps:

Prerequisites: Node 10 (or newer) installed in your computer.

  1. Fork this repository and clone your fork.
  2. Run npm install in the root folder.
  3. Run cd examples/mars-theme-example/ to go to the example directory.
  4. Run npx frontity dev to start Frontity with mars-theme on localhost:3000.
  5. Make any changes you consider to the packages.

WARNING: After adding/removing dependencies to a package, go back to the root and do npm install again.

  1. Run npm test in the root to check if the commit is acceptable.
  2. Commit and push to your fork.
  3. Open a Pull Request detailing the changes.

WARNING: npm test will be run automatically each time your commit or push, so it may take a while. If it fails, it won't let you commit/push. Fix the tests and try again.

If you get stuck on any of these steps, you should check the Code Contributions guide.

Other types of contributions

There are several ways to support the project and get involved. Don't know how to code? Don't worry! You can contribute in many other ways, just check our How to contribute page.