Skip to content

Latest commit

 

History

History
55 lines (42 loc) · 3.24 KB

CONTRIBUTING.md

File metadata and controls

55 lines (42 loc) · 3.24 KB
Raw

Contributing to Project Mētis

We appreciate your interest in contributing to Project Mētis! This document outlines the guidelines for submitting code contributions, reporting bugs, and proposing new features.

Getting Started

  1. Fork the Repository: Create a fork of the Project Mētis repository on GitHub.
  2. Clone your Fork: Clone your forked repository to your local machine using Git. 
    git clone https://<your_username>@github.com/<your_username>/project-metis.git
    Replace <your-username> with your actual GitHub username.
  3. Set up your Development Environment: Install the required dependencies for the project. Refer to the README file for specific instructions.
  4. Create a Branch: Create a new branch for your feature or bug fix. This helps keep your changes isolated from the main codebase. 
    git checkout -b <branch-name>
    Replace <branch-name> with a descriptive name for your branch (e.g., fix-navigation-bug, add-user-profile-feature).

Making Changes:

  1. Make your changes: Edit the relevant files and implement your desired changes.
  2. Write Unit Tests: (Highly recommended) Add unit tests for your changes to ensure functionality and prevent regressions. Refer to the project's testing framework documentation for guidance.
  3. Commit your Changes: Commit your changes to your local branch with a descriptive commit message. Use clear and concise language that reflects the purpose of your changes. 
    git add <modified-files>
git commit -m "<descriptive commit message>"
    Replace <modified-files> with a list of files you modified.

Submitting your Contribution:

  1. Push your changes: Push your committed changes to your forked repository on GitHub. 
    git push origin <branch-name>
    Replace <branch-name> with the name of the branch you created in step 4.
  2. Create a Pull Request: Navigate to your forked repository on GitHub and create a pull request.
  3. Fill out the Pull Request Template: Provide a clear description of your changes, including the issue being addressed or the feature being added. Follow any existing pull request template guidelines.
  4. Review Process: We will review your pull request and provide feedback. You may need to make further changes based on the feedback before your contribution is merged.

Contribution Guidelines:

  • Follow Code Style: Adhere to the existing code style conventions used in the project.
  • Write Clear and Concise Code: Strive for clean, well-commented code that is easy to understand and maintain.
  • Test your Changes: Ensure your changes don't introduce any unintended behavior. Use unit tests to verify functionality whenever possible.
  • Communicate Effectively: Clearly explain your changes in the pull request description. Be responsive to feedback and willing to make adjustments as needed.

Reporting Issues

If you encounter any bugs or have suggestions for improvement, please submit an issue on the GitHub repository. Be sure to provide a clear description of the issue, including steps to reproduce it if possible.

Thank You!

We appreciate your contributions to Project Mētis! Your help ensures the growth and improvement of this project.