Contributing

Contributing

Code Style

To maintain consistency and readability in the codebase, please adhere to the following code style guidelines:

• Python:

  • Follow PEP 8 guidelines.
  • Use meaningful variable and function names.
  • Include docstrings for all functions and classes.
  • Use type hints where applicable.
  • Limit line length to 79 characters.

• Assembly:

  • Use consistent indentation (e.g., 4 spaces).
  • Comment your code to explain the purpose of each section.
  • Use meaningful labels and variable names.
  • Group related instructions together and separate them with blank lines for readability.

• General:

  • Write clear and concise commit messages.
  • Ensure your code is well-documented.
  • Run tests before submitting your code.

Submitting Issues

If you encounter any issues or have suggestions for improvements, please follow these steps to submit an issue:

1. Search Existing Issues: Before submitting a new issue, check if it has already been reported.
2. Create a New Issue: If the issue is not already reported, create a new issue using the issue template.
3. Provide Details: Include a clear and descriptive title, a detailed description of the issue, steps to reproduce, and any relevant screenshots or logs.
4. Label the Issue: Use appropriate labels to categorize the issue (e.g., bug, enhancement, question).

Pull Requests

We welcome contributions from the community! To submit a pull request, follow these steps:

1. Fork the Repository: Create a fork of the repository on GitHub.

2. Clone Your Fork: Clone your forked repository to your local machine.

   git clone https://github.com/yourusername/malware-education.git
   cd malware-education

3. Create a Branch: Create a new branch for your feature or bug fix.

   git checkout -b feature-or-bugfix-name

4. Make Changes: Implement your changes, following the code style guidelines.

5. Commit Changes: Commit your changes with a clear and descriptive commit message.

   git commit -m "Description of the changes"

6. Push to Your Fork: Push your changes to your forked repository.

   git push origin feature-or-bugfix-name

7. Create a Pull Request: Go to the original repository on GitHub and create a pull request from your fork. Provide a clear description of your changes and link to any relevant issues.

8. Address Feedback: Be responsive to any feedback or requests for changes from the maintainers.

Thank you for contributing to the Malware Education repository!