Contributing

We enthusiastically encourage contributions to SMV2rho. Whether you have identified a bug, you think there is some functionality missing, or you have an idea for an improved method for calculating crustal density then please do get in touch.

If you’re ready to contribute, here’s how you can do it:

1. Fork the repository: Click the ‘Fork’ button at the top right of this page and clone your forked repository to your local machine.

2. Create a new branch: From your terminal, create a new branch for the new method that you want to add, bug you want to fix, or feature you want to work on. You can create a new branch with git checkout -b branch-name.

3. Make your changes: Make the changes you want to contribute. Whether it is adding a new method to convert velocity to density, fixing a bug, improving documentation, or adding a new feature of some other type, we really appreciate feedback, new features and improvements!

4. Commit your changes: Once you’re done, commit your changes with git commit -m "Your detailed commit message". Please add as much information as possible to your commit messages.

5. Push your changes: Push your changes to your forked repository with git push origin branch-name.

6. Create a pull request: Go to your forked repository on GitHub and click the ‘New pull request’ button. Fill out the form and then submit the pull request.

We will take a look at your pull request as soon as we can!