Skip to content

Latest commit

 

History

History
40 lines (28 loc) · 2.02 KB

CONTRIBUTING.md

File metadata and controls

40 lines (28 loc) · 2.02 KB
Raw

Contributing to Medusa

Thank you so much for contributing to Medusa. We appreciate your time and help. Here are some guidelines to help you get started.

Code of Conduct

Be kind and respectful to the members of the community. Take time to educate others who are seeking help. Harassment of any kind will not be tolerated.

Questions

If you have questions regarding Medusa, feel free to create an issue with your question in the repository

Filing a bug or feature

  1. Before filing an issue, please check the existing issues to see if a similar one was already opened. If there is one already opened, feel free to comment on it.
  2. If you believe you've found a bug, please provide detailed steps of reproduction, the version of Medusa and anything else you believe will be useful to help troubleshoot it (e.g. OS environment, environment variables, etc...). Also state the current behavior vs. the expected behavior.
  3. If you'd like to see a feature or an enhancement please open an issue with a clear title and description of what the feature is and why it would be beneficial to the project and its users.

Quick steps to contribute

  1. Fork the project.
  2. Download your fork to your PC (git clone https://github.com/your_username/medusa && cd medusa)
  3. Create your feature branch (git checkout -b my-new-feature)
  4. Make changes and run tests (make test)
  5. Add them to staging (git add .)
  6. Commit your changes (git commit -m 'Add some feature')
  7. Push to the branch (git push origin my-new-feature)
  8. Create new pull request

Sync your fork for further development

If you have forked Medusa before and need to update / sync your repo with the upstream repository, here's a guide to do that

  1. Add the remote, call it "upstream" (git remote add upstream https://github.com/jonasvinther/medusa)
  2. Fetch all the branches of that remote into remote-tracking branches (git fetch upstream)
  3. Make sure that you're on your master branch (git checkout main)
  4. Rewrite your main branch (git rebase upstream/main)