Skip to content

Latest commit

 

History

History
22 lines (15 loc) · 1.4 KB

CONTRIBUTING.md

File metadata and controls

22 lines (15 loc) · 1.4 KB

Contributions to the repliMAT materials are welcomed! Please follow the guidance below prior to making contributions to ensure that your kind efforts do not go to waste.

The project's source code and development is managed at its GitHub repository. There are a few ways to contribute, depending on whether you want to make changes to the source code or not.

In all interactions, please abide by the code of conduct

Issues

Open a new issue to describe a bug, error or to request changes.

Contributing code

If contributing source code changes to the project please follow the following workflow:

  1. Make a fork of the repository on GitHub.
  2. Clone your fork to your local machine and make a new branch with a name relevant to the task you're working on.
  3. Make some changes and ensure that the pages render as expected by following the instructions in the README to render the materials.
  4. Commit those changes with meaningful commit messages.
  5. Push your branch to GitHub and open a pull request against the upstream repository's main branch.
  6. In the pull request description, please reference the issue that you are resolving.
  7. Someone will review your pull request and hopefully it will be merged! 🎉