Skip to content

Latest commit

 

History

History
60 lines (40 loc) · 2.98 KB

CONTRIBUTING.md

File metadata and controls

60 lines (40 loc) · 2.98 KB

Contributing to MultiLang-Algo

I'm glad you want to contribute to my MultiLang-Algo repository. This is a project where I share sample code, scribbles, and algorithms from various programming languages. Here are some guidelines to help you get started.

How to contribute

There are many ways you can contribute to this project, such as:

  • Reporting bugs or suggesting enhancements
  • Adding new code, scribbles, or algorithms in different languages
  • Improving the existing code, scribbles, or algorithms
  • Writing or updating documentation
  • Reviewing pull requests

Code of conduct

Please read and follow the code of conduct before you interact with the project. I want this to be a welcoming and respectful community for everyone.

Issues

If you encounter a bug or have a feature request, please check the existing issues first to see if someone else has already reported it. If not, you can create a new issue and describe the problem or idea in detail. Please include as much information as possible, such as:

  • The steps to reproduce the bug or the motivation for the feature request
  • The expected and actual behavior
  • The environment where the bug occurs (e.g., operating system, browser, etc.)
  • Any relevant screenshots or error messages

Pull requests

If you want to make changes to the code, scribbles, or algorithms, please follow these steps:

  1. Fork the repository and create a new branch from the main branch.
  2. Make your changes and commit them with a clear and concise message. Please follow the commit message guidelines.
  3. Push your branch to your fork and [create a pull request] from it.
  4. Wait for me or someone else to review your pull request and provide feedback or approval.
  5. If there are any comments or requests for changes, address them and update your pull request.
  6. Once your pull request is merged, you can delete your branch.

Documentation

If you want to help with writing or updating documentation, such as README files, comments, or wiki pages, please follow these guidelines:

  • Use clear and simple language that is easy to understand.
  • Follow the [GitHub Flavored Markdown] syntax for formatting.
  • Check your spelling and grammar before submitting your changes.
  • Provide relevant examples or screenshots if possible.

Reviewing

If you want to help with reviewing pull requests from other contributors, please follow these guidelines:

  • Be polite and respectful. Do not make personal attacks or criticize anyone's work harshly.
  • Provide constructive and specific feedback that can help improve the quality of the code, scribbles, or algorithms.
  • Explain your reasoning behind your comments or suggestions.
  • If you are not sure about something, ask questions or request clarification.
  • If you approve a pull request, leave a positive comment or emoji.

Thank you

I appreciate your interest and effort in contributing to this project. I hope you enjoy learning and sharing different programming languages with me and others. Thank you! 😊