Skip to content

Latest commit

 

History

History
54 lines (37 loc) · 2.85 KB

CONTRIBUTING.md

File metadata and controls

54 lines (37 loc) · 2.85 KB

Contributing to Learn FHE

First off, thank you for deciding to contribute! Your help is greatly appreciated.

The following is a set of guidelines for contributing to this repository. These are guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

How Can I Contribute?

Reporting Issues

If you find an issue with the resources or content provided in this repository, please report it by opening an issue on GitHub. Include as much detail as possible to help us understand and resolve the issue:

  • Title: A clear and descriptive title
  • Description: A detailed description of the issue
  • Steps to Reproduce: Instructions to reproduce the issue, if applicable
  • Expected Behavior: What you expected to happen
  • Actual Behavior: What actually happened
  • Screenshots or Links: Any relevant screenshots or links

Suggesting Enhancements

If you have an idea for a new feature, resource, or an improvement to an existing feature, we would love to hear about it. Please open an issue on GitHub and include:

  • Title: A clear and descriptive title
  • Description: A detailed description of the enhancement
  • Examples: Any relevant examples, screenshots, or links

Contributing Content

To contribute content, such as new resources, guides, or research papers, please follow these steps:

  1. Fork the Repository: Fork the repository to your own GitHub account.
  2. Clone the Repository: Clone the forked repository to your local machine.
  3. Create a Branch: Create a new branch for your changes (git checkout -b add-new-resource).
  4. Make Changes: Add your new content or make changes in your branch.
  5. Commit Changes: Commit your changes with a clear and concise message (git commit -m "Add new resource on FHE").
  6. Push Changes: Push your changes to your fork (git push origin add-new-resource).
  7. Open a Pull Request: Open a pull request from your fork to the main repository.

Adding New Resources

If you have found a new resource (e.g., blog post, research paper, tutorial) that you think would be valuable to the community, please submit it by opening an issue or creating a pull request with the following information:

  • Title: Title of the resource
  • Link: Link to the resource
  • Description: A brief description of what the resource covers

Community and Contributions

We welcome all contributions to this repository! If you have any resources, papers, or tutorials to add, please follow the guidelines above. For larger changes or new features, it is often a good idea to start by opening an issue to discuss the change and get feedback.

License

By contributing to Learn FHE, you agree that your contributions will be licensed under the MIT License.

Thank you for your contributions!

Built with ❤️ by motypes