Skip to content

Contribution

WaLSAtools is an open-access and open-source library designed for researchers across diverse fields interested in analyzing oscillatory phenomena. Initially developed and maintained by the WaLSA team, the project is driven by a commitment to openness, transparency, and reproducibility in research. By sharing this evolving codebase on GitHub, we aim to foster collaboration, enabling contributions from a broad community to refine and extend its functionality. We welcome feedback, suggestions, and contributions that help improve WaLSAtools and expand its applications.

The WaLSAtools package provided here marks the beginning of an exciting journey. We envision that the broader community will contribute to advancing these tools and methodologies. The core of WaLSAtools is built upon Python, a widely-used programming language in science and engineering, ensuring accessibility and ease of use for a broad audience. To further enhance accessibility, we are actively developing counterparts in other popular languages. Currently, WaLSAtools is also available in IDL, with plans to expand to additional languages, such as MATLAB, in the future.

Contributions of all kinds are welcome and highly appreciated!

GitHub

WaLSAtools is managed using Git as a distributed version control system and is hosted on GitHub. To contribute, you will need a GitHub account. Contributions can take various forms, such as forking the repository to submit changes via a pull request, reporting issues, or engaging in discussions directly on GitHub. If you are new to GitHub, we recommend exploring these guides and resources.

Bug Reports

Bugs are tracked through the GitHub issue tracker. Before submitting a new bug report, please consult the Introduction and Troubleshooting sections under Getting Started. Additionally, search the existing issues database to see if your question or concern has already been addressed.

When reporting a bug, please include the following details:

  • WaLSAtools version
  • Version of Python or IDL
  • Operating System and version
  • Any error messages or terminal/Jupyter-notebook output
  • A clear and detailed description of the issue
  • Examples for reproducing the error (including plain text code or steps).

Providing detailed and accurate information increases the likelihood of a prompt and effective resolution. If you are unsure whether something is a bug, consider posting your question in our GitHub discussions first.

Feature Requests

We encourage users to suggest new features, analysis methods, or additional functionality. You can share your ideas in the Wish List section of our GitHub discussions. Before submitting a feature request, please verify that it is not already Under Development.

Reviewing Codes and Methods

The quality and reliability of the WaLSAtools codes and methods are our top priorities. We invite you to participate in code reviews, examine pull requests, and provide suggestions for improvement. Discussions about solutions or potential enhancements to the methods are also welcome. For general questions or comments, please use the GitHub discussions.

Answering Questions

We encourage researchers across diverse fields to actively support one another by responding to questions posted in the issue tracker or GitHub discussions. Sharing your expertise and experiences can be invaluable to others facing similar challenges or looking for advice on specific tasks.

Pull Requests

Pull requests are a key way to contribute to WaLSAtools. Whether fixing bugs or adding new features, we value your input. For details on setting up a development environment and understanding the contribution process, please refer to the Development page.

Documentation Improvements

We strive to provide not only reliable and user-friendly tools but also comprehensive documentation and examples. If you identify areas where the documentation can be enhanced, your contributions are highly appreciated. Guidance on editing documentation is available on the Development page.