Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
67 lines (43 loc) · 2.58 KB

CONTRIBUTING.md

File metadata and controls

67 lines (43 loc) · 2.58 KB

Contributing

Thank you for considering contributing to MemoGen! We welcome all types of contributions, whether it's bug reports, feature suggestions, or code improvements.

How to Contribute

  1. Fork the Repository:

    • Navigate to our GitLab repository: MemoGen on GitLab.
    • Click on the "Fork" button to create your own copy of the repository.

  2. Clone your Forked Repository:

    git clone https://git.tonic-ai.com/<your-username>/memogen.git  
cd memogen

  3. Create a New Branch:

    git checkout -b feature-or-fix-description

  4. Make Your Changes:

    • Implement your feature, bug fix, or enhancement.
    • Ensure you follow the existing code style and add comments where necessary.
    • Write tests if your changes include new functionality.

  5. Commit and Push Your Changes:

    git add .  
git commit -m "Description of the feature or fix"  
git push origin feature-or-fix-description

  6. Create a Merge Request:

    • Go to your forked repository on GitLab.
    • Click on "Merge Requests" and then "New Merge Request."
    • Select the source branch (the one you created) and the target branch (main or develop, as specified in the repository guidelines).

Join Our Community

We invite all contributors to join our builder's community on Discord! It's a great place to introduce yourself, share what you're working on, and get involved in exciting new projects. Whether you're a seasoned developer or just starting out, our community is here to help.

Cross Posting and Self Promotion

We're always building cool projects and love to see what our contributors are working on. Feel free to cross post your contributions and self-promote within our community. It's a great way to get feedback, connect with like-minded individuals, and grow your network.

Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct. Please read it to understand the expectations for all contributors.

Additional Resources

  • Issue Tracker: Check for open issues that need attention.
  • Documentation: Ensure you read the existing documentation and contribute improvements if necessary.

We're excited to see your contributions and welcome you to our community. Happy coding!

By contributing to MemoGen, you agree to the terms specified in the MIT License.