Onboarding Guide for gofannon (Start Here)

[rawkintrevo]

1. 👋 Say Hello

   • Introduce yourself on the project’s Github Discussion

2. 📖 Read the Documentation

   • Review the README, CONTRIBUTING guidelines, and website to get up to speed.

3. 🍴 Fork & Clone

   • Fork the repository on GitHub and clone it locally.
   • git clone git@github.com:The-AI-Alliance/gofannon.git

4. 👀 Explore Issues & Projects

   • Check out "good first issue"s

5. 💡 Pick a Task

   • Choose a task that matches your interests or skills (or challenges you to learn).

6. 🤝 Ask Questions

   • Don’t be shy: discuss your approach or any blockers with maintainers and fellow contributors.
   • This project uses The Q&A Section of Github Discussions as the source of truth. Look there first, and if you don't see your question answered, ask!

7. ✏️ Make Changes

   • Write code, documentation, or tests based on the project’s coding standards.
   • See the how-to guide

8. ✅ Test Your Work

   • Run tests locally to ensure everything functions correctly.

9. 🔀 Create a Pull Request

• Submit your changes for review, providing a clear description of what was done.

11. 🗣️ Engage in Review

• Respond to feedback, make improvements, and ask for clarifications when needed.

12. 🚀 Celebrate Your Merge

• Once approved, your contribution is merged—congrats! Share the news and keep contributing.

13. 📢 Stay Involved

• Follow discussions, help others, and keep improving the project.
• Join our discord
• Try to attend out bi-weekly call.

[truffleplanet]

I think the how-to guide link should be updated to:

https://the-ai-alliance.github.io/gofannon/developers/first_contribution.html

[rawkintrevo]

You're probably right, which 'how-to' guide?

[truffleplanet]

I was referring to the “See the how-to guide” link under step 7 (“✏️ Make Changes”).

[rawkintrevo]

✅ good catch, thanks @truffleplanet!