Contribution to Fed2Tier

Reporting bugs

To report bugs or request features, we utilize GitHub issues. If you come across a bug or have an idea for a feature, don’t hesitate to open an issue.

If you encounter any problems while using this software package, please submit a ticket to the Bug Tracker. Additionally, you can post pull requests or feature requests.

Contributing to Fed2Tier

If you wish to contribute to the project by submitting code, you can do so by creating a Pull Request. By contributing code, you agree that your contributions will be licensed under Apache License, Version 2.0.

We encourage you to contribute to the enhancement of Fed2Tier or the implementation of existing FL methods within Fed2Tier. The recommended method for contributing to Fed2Tier is to fork the main repository on GitHub, clone it, and develop on a branch. Follow these steps:

  1. Click on “Fork” to fork the project repository.

  2. Clone your forked repository from your GitHub account to your local machine:

    $ git clone https://github.com/apoorvakliv/fed2tier
    

    and then navigate to the Fed2Tier directory using the command

    $ cd fed2tier
    
  3. Create a new branch to save your changes using the command

    $ git checkout -b my-feature
    
  4. Develop the feature on your branch and use the command

    $ git add modified_files
    

    followed by

    $ git commit
    

    to save your changes.

Pull Request Checklist

  • Please follow the file structure below for new features or create new file if there are something new.