Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
44 lines (28 loc) · 1.72 KB

CONTRIBUTING.md

File metadata and controls

44 lines (28 loc) · 1.72 KB
Raw

Contributing to Finitewave

Want to contribute to Finitewave? Contributions are welcome!

Reporting Issues

If you encounter a bug or unexpected behavior, please open an issue on the GitHub repository.

To make your report more helpful, consider including the following information:

  • A clear description of the problem.
  • The error (or warning) message you get.
  • Steps to reproduce the issue.
  • The version of Finitewave you are using.
  • The operating system and Python version.

Asking Questions or proposing features

Do you have questions, feature proposals or other suggestions? You can also open a GitHub issue.

Contributing Code

We really appreciate it if you contribute to Finitewave.

Here is how you can help:

  1. Technical issues. Bug fixes, performance improvements, documentation improvements. These are always welcome.
  2. New tutorials. The most valuable and accessible contribution you can make is to create a tutorial based on Finitewave. This could be your paper or research that solves a scientific, engineering, or educational problem.
  3. New examples. Could also be useful if you see an uncovered functionality.

To contribute code:

  1. Fork the repository.
  2. Create a new branch for your change.
  3. Implement your changes. Try to keep the code readable and add comments when needed.
  4. Don't forget to document your code.
  5. Be sure that the tests are working and add new tests if you made a new feature.
  6. Submit a pull request describing the changes.

All contributions will be reviewed before merging.

Coding Style

Finitewave aims to maintain readable and well-structured Python code. Please follow common Python conventions and keep the code consistent with the existing style.