Skip to content

Latest commit

 

History

History
89 lines (61 loc) · 3.48 KB

CONTRIBUTING.md

File metadata and controls

89 lines (61 loc) · 3.48 KB
Raw

Contributing to ML4E

Thank you for your interest in contributing to ML4E: Machine Learning for Everyone! We’re thrilled to have you here, and we’re excited about your ideas, skills, and enthusiasm for making machine learning accessible to all.

Getting Started

1. Fork the Repository

Fork the repository by clicking on the "Fork" button at the top of the GitHub page. This creates a copy of the ML4E project in your GitHub account.

2. Clone Your Fork

Clone the forked repository to your local machine to begin working on it.

git clone https://github.com/your-username/ML4E.git
cd ML4E

3. Install Dependencies

Ensure you have Node.js (version 14 or above) and npm installed. Install the project dependencies with:

npm install

4. Start the Development Server

To preview ML4E locally, start the development server:

npm run dev

Open http://localhost:3000 in your browser to view the application.

Contribution Workflow

1. Create a New Branch

Before making any changes, create a new branch to isolate your work:

git checkout -b feature/your-feature-name

Branch names should be descriptive of the feature or fix (e.g., feature/add-homepage or fix/typo-in-readme).

2. Make Your Changes

Start coding, documenting, or updating any aspect of ML4E! Ensure your code adheres to project standards and is clean, readable, and well-documented.

3. Commit Your Changes

Write a clear, descriptive commit message that explains the purpose of your changes.

git commit -m "Add feature: Describe your feature here"

4. Push Your Branch to GitHub

Push your changes to your forked repository:

git push origin feature/your-feature-name

5. Open a Pull Request (PR)

Navigate to the Pull Requests section of the original ML4E repository and open a pull request. Include a detailed description of the changes, linking any relevant issues if applicable.

Code Standards

  • Consistency: Follow the project’s existing code style and formatting.
  • Comments: Use comments to explain complex sections or logic where necessary.
  • Commit Messages: Write clear and concise commit messages that summarize changes.

Reporting Issues

If you find a bug, have a feature request, or would like to suggest improvements, feel free to create an issue in the repository. Please provide as much detail as possible and, if applicable, add screenshots to help illustrate your ideas or findings.

Code of Conduct

This project aims to create a friendly and collaborative environment. Please be respectful, constructive, and inclusive in all your communications.

Need Help?

If you have any questions, ideas, or need guidance at any step, feel free to reach out! Here are a few ways to get in touch:

  • Discussions: For general questions, brainstorming, or sharing ideas, head over to the Discussions tab. This is a great place to connect with other contributors, suggest new features, or discuss project improvements.

  • Issues: If you encounter a bug or have a specific technical question, please create an issue in the Issues section. Be sure to include relevant details or screenshots to help us understand and address your question efficiently.

We're here to help and excited to see ML4E grow with your contributions!