Skip to content

Latest commit

 

History

History
36 lines (26 loc) · 2.03 KB

CONTRIBUTION_GUIDE.md

File metadata and controls

36 lines (26 loc) · 2.03 KB

Interested in contributing? MoleculARweb is an open-source project with the goal of making chemistry and biology education available to everyone, everywhere, through augmented reality.

Get Help or Ask a Question

If you are not sure how to do something with MoleculARweb, please let us know by sending an email or filing an issue.

You can reach out to us at:

Luciano Abriata: [email protected]

Fabio Cortés: [email protected]

File an issue

  1. Search the issue tracker for similar issues.
  2. Specify the details of the device in which the bug occurred.
  3. Specify information about your browser and system (e.g., "Firefox on OS X")
  4. Describe the problem in detail (i.e., what happened and what you expected would happen).
  5. If possible, provide a screenshot.

Contribute Code to MoleculARweb

  1. Have a GitHub account with SSH keys set up.
  2. Fork the repository on GitHub.
  3. Clone your fork of the repository locally (i.e., git clone [email protected]:yourusername/molecular-mirror-app).
  4. Create a branch to work in (i.e., git checkout -b mybranch).
  5. Make changes to your fork of the repository, commit them, and push them (i.e., git add -A . && git commit -m 'My Changes (fixes #1234)' && git push origin mybranch).
  6. Submit a pull request against the master branch. If you head to the MoleculARweb repository after running git push from earlier, you should see a pop up to submit a pull request.
  7. Address review comments if any.

If you want to contribute with translations follow these steps:

  1. Look for the language prefix. For example, “en”, “es”, “fr” etc.
  2. Create a folder inside the locales directory using that prefix as name.
  3. Copy and paste translations.json from “en” folder so you can use it as template.
  4. Replace all values inside that file. Do not change the key, otherwise it will not work, just edit the text like this: “doNotEdit”: “Edit me in your language 😊”.
  5. Once you are done, follow the previous guide to submit a PR.