jacob1017 / folly

An open-source C++ library developed and used at Facebook.
https://groups.google.com/forum/?fromgroups#!forum/facebook-folly
Apache License 2.0
0 stars 0 forks source link

Sweep: add an Readme.md with author infor #2

Open jacob1017 opened 9 months ago

jacob1017 commented 9 months ago
Checklist - [X] Modify `README.md` ! No changes made [Edit](https://github.com/jacob1017/folly/edit/sweep/add_an_readmemd_with_author_infor/README.md) - [X] Running GitHub Actions for `README.md` ✗ [Edit](https://github.com/jacob1017/folly/edit/sweep/add_an_readmemd_with_author_infor/README.md)
sweep-ai[bot] commented 9 months ago
Sweeping

50%

Actions (click)

GitHub Actions failed

The sandbox appears to be unavailable or down.


❌ Unable to Complete PR

I'm sorry, but it looks like an error has occurred due to a planning failure. Feel free to add more details to the issue description so Sweep can better address it. Alternatively, reach out to Kevin or William for help at https://discord.gg/sweep.

For bonus GPT-4 tickets, please report this bug on Discord (tracking ID: 98e21b58ed).


Please look at the generated plan. If something looks wrong, please add more details to your issue.

File Path Proposed Changes
README.md Modify README.md with contents:
• Start by creating a new file named README.md at the root of the folly repository.
• Begin the README.md file with a title and a brief introduction to the folly library. For example:
```
# Folly Library

Folly (Facebook Open-source Library) is an open-source C++ library developed and used at Facebook. It is designed to be a collection of reusable C++ library artifacts developed and used at Facebook, aiming to complement the standard library.
```
• Add a section titled "Authors" to credit significant contributors to the library. Given the information from the snippets, include Nathan Bronson and Xiao Shi as contributors to the F14 data structures. For example:
```
## Authors

- Nathan Bronson ngbronson@fb.com - Contributions to F14 data structures.
- Xiao Shi xshi@fb.com - Contributions to F14 data structures.
```
• Optionally, include a section for "Contributing" to guide new contributors on how to get involved with the project. This section can briefly mention the process for submitting issues and pull requests. For example:
```
## Contributing

We welcome contributions to the Folly library. If you're interested in contributing, please review our contributing guidelines and submit your pull requests. For more information, see CONTRIBUTING.md.
```
• Finally, add a section for "License" to mention the licensing under which the folly library is released. Given the snippets, it's clear that folly is licensed under the Apache License, Version 2.0. For example:
```
## License

The Folly library is licensed under the Apache License, Version 2.0. See LICENSE for more details.
```
• This README.md file will serve as a comprehensive introduction to the folly library, providing essential information about the project, its authors, how to contribute, and its licensing.

🎉 Latest improvements to Sweep:
  • New dashboard launched for real-time tracking of Sweep issues, covering all stages from search to coding.
  • Integration of OpenAI's latest Assistant API for more efficient and reliable code planning and editing, improving speed by 3x.
  • Use the GitHub issues extension for creating Sweep issues directly from your editor.

💡 To recreate the pull request edit the issue title or description. To tweak the pull request, leave a comment on the pull request.

This is an automated message generated by Sweep AI.