Skip to content

Latest commit

 

History

History
66 lines (40 loc) · 4.39 KB

CONTRIBUTING.md

File metadata and controls

66 lines (40 loc) · 4.39 KB

Contributing to informatician

Thank you for your interest in contributing to informatician! This project aims to provide useful resources i.e., Books for information and research purposes to its users. You can learn more about the purpose and features of this project by reading the README.md file. We welcome all types of contributions, such as bug reports, feature requests, documentation improvements, code enhancements, and more. Please read this guide carefully before making your contribution.

Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct. This code of conduct outlines the expectations for behavior, language, and interactions with other contributors in this project. We want to create a positive and respectful environment for everyone involved. Please report any unacceptable behavior to rohanshx@gmail.com.

How to Contribute

There are many ways you can help improve this project. Here are some general guidelines for different types of contributions:

Reporting Bugs

If you encounter a bug or an error while using informatician, please open an issue and provide the following information:

  • A clear and descriptive title
  • A detailed description of the problem, including steps to reproduce it and expected behavior
  • The version of informatician and any other relevant software or packages you are using
  • Any screenshots or error messages that can help us diagnose the issue

We will try to fix the bug as soon as possible. Thank you for helping us make informatician more reliable!

Suggesting Enhancements

If you have an idea for a new feature or an improvement to an existing one, please open an issue and provide the following information:

  • A clear and descriptive title
  • A detailed explanation of your suggestion, including why you think it would be useful and how it would work
  • Any examples or mock-ups that can illustrate your idea
  • Any relevant links or references that can support your suggestion

We will review your suggestion and discuss its feasibility and implementation. Thank you for helping us make informatician more useful!

Making Code Contributions

If you want to contribute code to informatician, please follow these steps:

  • Fork the repository and create a new branch for your feature or bug fix
  • Commit your changes with a clear and descriptive message
  • Push your branch to your fork and open a pull request against the main branch
  • Wait for our review and feedback. We may ask you to make some changes or additions before merging your pull request.

Please note that we only accept pull requests that are related to an existing issue or a previously discussed enhancement. If you want to work on something that is not covered by an issue or a discussion, please open one first.

Thank you for sharing your code with us!

Improving Documentation

If you want to improve the documentation of informatician, such as the README, the wiki, or the code comments, please follow these steps:

  • Fork the repository and create a new branch for your documentation update
  • Make sure your documentation follows our style guide and is clear, concise, and accurate
  • Commit your changes with a clear and descriptive message
  • Push your branch to your fork and open a pull request against the main branch
  • Wait for our review and feedback. We may ask you to make some changes or additions before merging your pull request.

Thank you for helping us improve our documentation!

How to Get Help

If you have any questions or need any help with informatician, please feel free to reach out to us at rohanshx@gmail.com or join our discussion forum. You can also find more information on how to use informatician in our documentation. We are happy to assist you with any issues or inquiries.

Thank You

We would like to thank all the contributors who have helped us improve informatician. Your contributions are valuable and make this project better for everyone. We hope you enjoy using informatician and find it helpful for your information projects. If you have any feedback or questions, please feel free to reach out to us at rohanshx@gmail.com or join our discussion forum . We would love to hear from you!