add contribution instructions

[jeandeb]

Contribution Instructions for rakam_systems

Thank you for your interest in contributing to rakam_systems! Follow the steps below to get started:

1. Fork the Repository

   • Start by forking the rakam_systems repository to your GitHub account.

2. Clone the Forked Repository

   • Clone the forked repository to your local machine:

     git clone <forked_repository_url> rakam_systems
     cd rakam_systems

3. Install Dependencies

   • Make sure you have all required dependencies installed. You can do this by installing them from requirements.txt:

     pip install -r requirements.txt

4. Install in Editable Mode

   • To make development easier, install rakam_systems in editable mode:

     pip install -e .

5. Create a New Branch

   • Create a new branch for your feature or bug fix:

     git checkout -b feature/your-feature-name

6. Make Your Changes and Test

   • Implement your changes, and write or update tests if necessary.
   • Run tests to ensure nothing is broken:

     pytest

7. Commit and Push Changes

   • Once your changes are complete, commit them with a meaningful message:

     git add .
     git commit -m "Add feature X or Fix issue Y"
     git push origin feature/your-feature-name

8. Submit a Pull Request

   • Go to the original rakam_systems repository on GitHub.
   • Click on New Pull Request and select your branch to submit your changes for review.

Guidelines

• Follow PEP8 coding standards.
• Update tests and documentation where applicable.
• Make sure your pull request has a descriptive title and clearly explains the changes made.

Thank you for helping us improve rakam_systems!

[jeandeb]

Contribution Instructions for rakam_systems

Thank you for your interest in contributing to rakam_systems! Follow the steps below to get started:

1. Fork the Repository

   • Start by forking the rakam_systems repository to your GitHub account.

2. Clone the Forked Repository

   • Clone the forked repository to your local machine:

     git clone <forked_repository_url> rakam_systems
     cd rakam_systems

3. Install in Editable Mode

   • To make development easier, install rakam_systems in editable mode. This will also install all required dependencies:

     pip install -e .

4. Create a New Branch

   • Create a new branch for your feature or bug fix:

     git checkout -b feature/your-feature-name

5. Make Your Changes and Test

   • Implement your changes, and write or update tests if necessary.
   • Run tests to ensure nothing is broken:

     pytest

6. Commit and Push Changes

   • Once your changes are complete, commit them with a meaningful message:

     git add .
     git commit -m "Add feature X or Fix issue Y"
     git push origin feature/your-feature-name

7. Submit a Pull Request

   • Go to the original rakam_systems repository on GitHub.
   • Click on New Pull Request and select your branch to submit your changes for review.

Guidelines

• Follow PEP8 coding standards.
• Update tests and documentation where applicable.
• Make sure your pull request has a descriptive title and clearly explains the changes made.

Thank you for helping us improve rakam_systems!