diff --git a/README.md b/README.md index 1edb7bf..1a92818 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,36 @@ # AFOS (AfricanOpenSource) -AFOS is a CHAOSS Africa and Github collaboration created to demonstrate how GitHub CoPilot enhances and improves developer productivity. The project involved creating a platform for showcasing Open Source projects build by Africans. +AFOS is a CHAOSS Africa and Github collaboration created to demonstrate how GitHub CoPilot enhances and improves developer productivity. The project involved creating a platform for showcasing Open Source projects build by Africans. -The team created a web project using CoPilot to generate code suggestions in real time to detemine CoPilot's impact on developer productivity. +The team created a web project using CoPilot to generate code suggestions in real time to detemine CoPilot's impact on developer productivity. ## Project design -- [figma](https://www.figma.com/file/mALWb4e0vqfBbtRwop3g16/Afos?type=design&node-id=543-3049&mode=design&t=Uc7cI6vMcv2Xzryg-0) + +* [figma](https://www.figma.com/file/mALWb4e0vqfBbtRwop3g16/Afos?type=design\&node-id=543-3049\&mode=design\&t=Uc7cI6vMcv2Xzryg-0) ## Main Objectives -- To demonstrate how GitHub CoPilot enhances productivity and reduces time it takes to deliver projects. -- To develop a story on how GitHub CoPilot makes a positive impact for social good. -- To train developers on how to use GitHub CoPilot in their Open Source communities. +* To demonstrate how GitHub CoPilot enhances productivity and reduces time it takes to deliver projects. +* To develop a story on how GitHub CoPilot makes a positive impact for social good. +* To train developers on how to use GitHub CoPilot in their Open Source communities. ## Contributing Guidelines This project is open to the community and anyone can contribute to it. To contribute to this project, ensure to follow the guidelines found [here](https://github.com/chaoss/GitHub-Copilot-Hackathon-Project/blob/main/CONTRIBUTING.md). + +## Hacktoberfest Guidelines + +Welcome to Hacktoberfest! + +Here's how to get started contributing during this Hacktoberfest: + +* For your Hacktober contribution to counted, Register at Https://Hacktoberfest.com (https://chaoss.community/kb-getting-started) +* Decide which areas you would like to contribute towards: + * Development: Check out the [open issues](https://github.com/chaoss/AFOS-AfricanOpenSource/issues) + + * Documentation: [Product design](https://github.com/peculiaruc/AFOS-AfricanOpenSource/blob/main/CONTRIBUTING.md#resources): Contact [Kingsly](https://github.com/iamkingsleey) if you need any guide. Please join our [Slack community channel](https://join.slack.com/t/chaoss-workspace/shared_invite/zt-2541kvhn5-Dhe~n0PjxBMpIfUtkRVSCw) for better communication. +* Ensure to go through the [Contributing Guidelines](https://github.com/chaoss/GitHub-Copilot-Hackathon-Project/blob/main/CONTRIBUTING.md) +* Resource: + * [How to start a great open source](https://go.gitlab.com/Hm4BNB) + * [How to write a good PR](https://github.blog/2015-01-21-how-to-write-the-perfect-pull-request/) + * [how to write a good commit message](https://dev.to/chrissiemhrk/git-commit-message-5e21)