Course

Credits, References, and Contact

Image

We are in the final stage of creating the perfect GitHub repository README.

Adding below final steps will help acknowledge contributors, provide sources, offer ways to get in touch, and clarify usage rights. It's to make your project more trustworthy, professional, and user-friendly.

So, let's get going

📜 Credits

Acknowledge the people who have contributed to your project including collaborators, mentors and any third party assets used. This is a great way to show appreciation and give credit where it's due.

Template

## 📜 Credits

I would like to thank the following people who contributed to this project:

- **Jane Doe** - _Project Lead_ - [@janedoe](https://github.com/janedoe)
- **John Smith** - _Backend Developer_ - [@johnsmith](https://github.com/johnsmith)
- **Emily Johnson** - _UI/UX Designer_ - [@emilyjohnson](https://github.com/emilyjohnson)

Additionally, I utilized the following third-party assets that require attribution:

- [OpenWeather API](https://openweathermap.org/api) - For weather data
- [FontAwesome](https://fontawesome.com/) - For icons

📚 References

List resources, research papers, tutorials or any other material that you found helpful during development.

Providing clear references indicates a commitment to thorough research and knowledge integration which are essential in technical roles

Template

## 📚 References

Here are some references I used for this project:

- Jonathan Lee, 'Notes on Naive Bayes Classifiers for Spam Filtering'. [Online]. Available: https://example.com
- [MDN Web Docs](https://developer.mozilla.org/) - For extensive documentation on web technologies
- [React Documentation](https://reactjs.org/docs/getting-started.html) - For guidance on React development

📞 Contact Us

Add any additional contact information, links, or other information you'd like to share. This helps users or potential emplouers get in touch with you and get support.

Template

## 📞 Contact Us

If you have any questions or feedback, feel free to reach out:

- **Follow us on Twitter**: [![Twitter](https://img.shields.io/twitter/follow/username?style=social)](https://twitter.com/username)
- **Connect on LinkedIn**: [![LinkedIn](https://img.shields.io/badge/LinkedIn-username-blue?style=flat&logo=linkedin)](https://www.linkedin.com/in/username/)
- **Email**: [username@example.com](mailto:username@example.com)

📋 License

If you want to specify the usage rights of your project, you can include a license. This is important for open-source projects to clarify how others can use, modify, and distribute your code.

Template

## 📋 License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

While these parts may not feel important, they are necessary for building trust and credibility with users and potential employers. They show that you are a responsible developer who values collaboration, research, and communication.

So, do it for every project you create!

0 Comments

"Please login to view comments"

glass-bbok

Join the Conversation!

Subscribing gives you access to the comments so you can share your ideas, ask questions, and connect with others.

Upgrade your account
tick-guideNext Lesson

Assignment: Credits, References, and Contact