Skip to content

Latest commit

 

History

History
81 lines (47 loc) · 3.02 KB

CONTRIBUTING.md

File metadata and controls

81 lines (47 loc) · 3.02 KB

Contributing to Awesome Vertical Federated Learning

Thank you for considering contributing to our curated list of valuable resources on Vertical Federated Learning! We welcome contributions from the community to help us improve and expand this repository.

How to Contribute

1. Fork the Repository

Begin by forking the repository to your GitHub account. You can do this by clicking the "Fork" button at the top right corner of the repository page.

2. Clone the Forked Repository

Clone the forked repository to your local machine. Use the following command in your terminal:

git clone https://github.com/ngc436/awesome-vertical-federated-learning.git

3. Create a New Branch

Create a new branch for your contribution. It is a good practice to use a descriptive name for your branch:

git checkout -b feature/add-new-resource

4. Make Your Changes

Make the necessary changes in your local repository. Ensure that your contributions are relevant to Vertical Federated Learning and provide value to the community.

5. Test Your Changes

Once you have made your changes, ensure they work as expected. Check for typos and accuracy of the information.

6. Commit Your Changes

Commit your changes to your branch with a descriptive commit message:

git add .
git commit -m "Add a new resource on Vertical Federated Learning"

7. Push to Your Fork

Push your changes to your forked repository:

git push origin feature/add-new-resource

8. Open a Pull Request

Navigate to the original repository on GitHub and open a pull request from your fork. Provide a clear and concise description of your changes. Include relevant details and any necessary context.

9. Review Process

The maintainers will review your pull request. Be responsive to feedback and make any required adjustments. Once approved, your changes will be merged into the main repository.

Contribution Guidelines

  • Relevance: Ensure that the resources you are adding are directly related to Vertical Federated Learning citation:1.
  • Quality: Only include high-quality resources. This can include research papers, articles, books, frameworks, libraries, and tools that provide significant valuecitation:1.
  • Format: Follow the existing format of the repository when adding new resources. Consistency is key to maintaining the quality of the list.
  • Descriptions: Provide clear and concise descriptions for each resource. Avoid adding links without context.

Code of Conduct

By participating in this project, you agree to abide by the Code of Conduct. Please read it to understand the expectations for interactions within the community.

Getting Help

If you need help or have any questions, feel free to open an issue in the repository. We encourage open and respectful communication.

Thank you for helping us build an awesome resource for the Vertical Federated Learning community!

Happy contributing!