eFFT
An efficient method for the calculation of the exact Fourier transform of an asynchronous event stream
 
Loading...
Searching...
No Matches
Contributing

Thank you for considering contributing to eFFT! We welcome contributions of all kinds, including bug fixes, new features, documentation improvements, and more.


How to Contribute

1. Fork the Repository

Start by forking the repository to your GitHub account.

2. Clone the Repository

Clone your forked repository to your local machine:

git clone https://github.com/your-username/efft.git

3. Create a Branch

Create a new branch for your changes:

git checkout -b feature-or-bugfix-name

4. Make Changes

Make your changes in the codebase. Be sure to follow the Development Guidelines.

5. Test Your Changes

Run the tests to ensure your changes do not break existing functionality.

6. Commit Your Changes

Write clear and concise commit messages:

git add .
git commit -m "Description of the changes"

7. Push Your Changes

Push your branch to your forked repository:

git push origin feature-or-bugfix-name

8. Open a Pull Request

Go to the original repository and open a pull request from your branch. Provide a detailed description of your changes.


Reporting Issues

If you encounter a bug or have a feature request, please open an issue in the repository. Include as much detail as possible, such as:

  • Steps to reproduce the issue
  • Expected behavior
  • Actual behavior
  • Screenshots or logs, if applicable

Submitting Changes

  • Ensure your code adheres to the project's coding standards.
  • Include tests for any new functionality or bug fixes.
  • Update documentation if your changes affect it.

Development Guidelines

  • Follow the existing code style and structure.
  • Write clear, maintainable, and well-documented code.
  • Use meaningful commit messages.
  • Ensure all tests pass before submitting a pull request.

License

By contributing to this project, you agree that your contributions will be licensed under the same license as the project. See the LICENSE file for details.


Thank you for your contributions!