Contributing to the easyphysics package

We appreciate your time and effort in contributing to this project. Any contributions are welcomed. These contributions include but are not limited to:

Report or fix bugs

Fix wrong analysis and typos

Report bugs or fix bugs

Provide feedback

Other meaningful input

How to contribute to this project

GitHub Issue

If you want to have any type of contributions to this package, please create a GitHub issue in our repository to inform us. Then please follow the instructions below for different types of contributions.

Code Contribution

Please set up easyphysics for local development.

  1. Please fork our easyphysics repository on GitHub and clone the for to your local machine. For more details on how to for a repository, see this GitHub Documentation.

Keep your local repository updated by pulling from our repository.

  1. Install easyphysics using poetry:

    $ poetry install

  2. Once your local environment is set up and up-to-date, when you want to make a contribution, please always create a new git branch that is going to contain your contribution.

Note Please do not make changes directly to the master branch.

```console
$ git switch -c <branch-name>
```

  1. When you’re done making changes, check that your changes conform to any code formatting requirements and pass any tests.

  2. Commit your changes and open a pull request.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request should include additional tests if appropriate.

  2. If the pull request adds functionality, the docs should be updated.

  3. The pull request should work for all currently supported operating systems and versions of Python.

When you are ready to submit the changes to our repository, please first commit them to your branch. You can use the following code:

$ git add <modified-file>
$ git commit -m "Some descriptive message about your change"
$ git push origin <branch-name>

Please create a pull request (PR) on GitHub asking to merge your brand to our main repository. For more information regarding pull request, please see here.

Types of Contributions

Report Bugs

Please create a GitHub issue in our repository to inform us. Please include:

  • Your operating system name and version.

  • Any details about your local setup that might be helpful in troubleshooting.

  • Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.

When you are ready to submit the fix to our repository, please first commit them to your branch. Please create a pull request (PR) on GitHub asking to merge your brand to our main repository.

Implement Features

Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.

Write Documentation

You can never have enough documentation! Please feel free to contribute to any part of the documentation, such as the official docs, docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

If you are proposing a feature:

  • Explain in detail how it would work.

  • Keep the scope as narrow as possible, to make it easier to implement.

  • Remember that this is a volunteer-driven project, and that contributions are welcome :)

Code of Conduct

Please note that the easyphysics project is released with a Code of Conduct. By contributing to this project you agree to abide by its terms. The link to our ‘Code of conduct’ is here.

Feedback

Our team would provide you with feedback when we received your contribution within 30 days through GitHub issue. We would reply your GitHub issue and keep you updated.

License

By contributing to this package, you agree that your contributions will be licensed under its MIT license.

References

This file is adapted from the Altair’s CONTRIBUTING.md document.