markdown-magic-maker / instructions.md
tfrere's picture
tfrere HF Staff
rajoute moi un fichier markdown avec des directives que je vais te donner
063009d verified

Project Instructions

            <div class="markdown-content">
                <!-- Start of markdown content -->
                <h1>Project Development Guidelines</h1>
                
                <p>Welcome to the project! Here are the essential guidelines for development:</p>
                
                <h2>1. Code Structure</h2>
                <ul>
                    <li>Follow the MVC pattern for better organization</li>
                    <li>Keep components modular and reusable</li>
                    <li>Use meaningful file and folder names</li>
                </ul>
                
                <h2>2. Styling Standards</h2>
                <p>We're using TailwindCSS for styling. Please adhere to:</p>
                <pre><code>// Good example
                &lt;div class="flex justify-between items-center p-4 bg-white rounded-lg shadow"&gt;
                    Content here
                &lt;/div&gt;</code></pre>
                
                <h2>3. JavaScript Best Practices</h2>
                <blockquote>
                    "Write code as if the person who ends up maintaining your code is a violent psychopath who knows where you live."
                </blockquote>
                <ol>
                    <li>Use ES6+ features</li>
                    <li>Implement proper error handling</li>
                    <li>Document complex functions</li>
                </ol>
                
                <h2>4. Testing Requirements</h2>
                <p>All features must include:</p>
                <ul>
                    <li>Unit tests for business logic</li>
                    <li>Integration tests for API calls</li>
                    <li>End-to-end tests for critical user flows</li>
                </ul>
                
                <h2>5. Deployment Process</h2>
                <pre><code># Deployment commands
                npm run build
                npm run test
                npm run deploy</code></pre>
                
                <h2>6. Collaboration Rules</h2>
                <p>Remember to:</p>
                <ul>
                    <li>Create feature branches</li>
                    <li>Submit PRs for review</li>
                    <li>Resolve merge conflicts properly</li>
                </ul>
                <!-- End of markdown content -->
            </div>
            
            <div class="mt-8 pt-6 border-t border-gray-200">
                <div class="flex items-center">
                    <div class="flex-shrink-0">
                        <i data-feather="alert-circle" class="text-yellow-500"></i>
                    </div>
                    <div class="ml-3">
                        <p class="text-sm text-gray-600">
                            Please review these guidelines before starting any work on the project.
                        </p>
                    </div>
                </div>
            </div>
        </div>
    </div>
</div>

<script>
    feather.replace();
    document.addEventListener('DOMContentLoaded', function() {
        // Any initialization code can go here
    });
</script>