Contributions

Pull requests welcome!

See issues for reporting bugs or problems.

Updating the Documentation

These docs are located within the same Github repository that is home to Makerverse. You’ll find them in the docs/ folder, stored as .md (markdown) files. Therefore, the contribution process is the same as changing the Makerverse code (see below). Once a pull request containing docs has been approved and merged, it will appear automatically on Makerverse.com.

Note: to test your changes to the docs, run bundle exec jekyll serve from the docs/ folder. You will need to have Ruby & Jekyll installed (see their docs).

How to Contribute

As with contributing to most Github projects, the process is to (1) fork the repository, (2) make and push changes, and then (3) create a pull request. The pull request can then be reviewed and accepted into Makerverse.

Fork the repository

If you’re using GitHub for Desktop application, navigate over to the toolbar, open the Clone or download dropdown, and click Open in Desktop to clone makermadecnc/makerverse to your computer and use it in GitHub Desktop.

Making and pushing changes

Go ahead and make a few changes to the project using your favorite text editor. When you’re ready to submit your changes, type up a commit summary in GitHub for Desktop, and click Commit to master.

You can continue to make more changes and create new commits. When you’re ready to push your changes, click on the Sync button to synchronize master with the remote server.

Creating the pull request

1. Head on over to the repository on GitHub.com where your project lives. For your example, it would be at https://www.github.com/<your_username>/makerverse.

2. To the right of the branch menu, click New pull request.
   

3. Click Create pull request.

4. That’s done.

Development

See the build from source section to get started.

Localization

If you’d like to help contribute translations, you can fork the repository, update resource files in the src/app/i18n directory, and create a pull request to submit your changes.

Translation Validation

You can validate the translation by copying translated resource files to the installed directory. Note that your path may differ based on the Node installation path you have in place.

$ cd $(dirname `which makerverse`)/../lib/node_modules/cncmakerversejs/dist/app/i18n/
$ pwd
/home/cheton/.nvm/versions/node/v10.15.3/lib/node_modules/makerverse/dist/app/i18n

To verify your changes during runtime, it’s recommended that you open Developer Tools and disable browser cache. For example:

Step 1: Open Developer Tools and click [Settings]

Step 2: Disable cache

Now you can copy resource files to the dist/makerverse/app/i18n directory and refresh your browser to see new updates.

Note that you should not close DevTools to make sure your browser won’t cache anything.