Skip to content

Latest commit

 

History

History
45 lines (27 loc) · 3.43 KB

contributing.md

File metadata and controls

45 lines (27 loc) · 3.43 KB
Raw

Contributing ❤️

Welcome to the Dividend Income Investment Calculator! This is an open source project that allows investors to calculate the expected dividend income from their investment portfolios. We appreciate your interest in contributing to the project and we welcome contributions from everyone, regardless of your experience level.

How to contribute 👀

Contributions are always welcome!

We're grateful for any contributions you can make to the project. Here are some ways you can get involved:

  • 🐞 Report a Bug: If you notice a bug in the calculator, please let us know by creating an issue in the project's issue tracker. We would appreciate it if you could describe the problem in detail, so we can understand it and fix it as soon as possible. If you are able to fix the bug yourself, you can submit a pull request with the fix.

  • 🎉 New Features: If you have an idea for a new feature that you would like to see in the calculator, we'd love to hear about it. Please create an issue in the project's issue tracker to discuss your idea, and we'll work with you to see if it's a good fit for the project. You can also submit a pull request with the new feature implementation.

  • 💻 Improve User Interface: If you have a knack for design and user experience, you can contribute by improving the user interface of the calculator. You can suggest changes to the layout, color scheme, or fonts used in the calculator. Please make sure that any changes you propose are easy to understand by the user and follow a clean and minimal approach.

  • 📄 Improve the Documentation: We know that good documentation is key to making the project accessible and easy to use. If you have suggestions for how we can improve the documentation, please let us know by submitting a pull request with the relevant changes. This can include improving the README file, adding documentation to the code, or creating a user guide, etc.

If you're not sure what to work on, take a look at the project's issues and see if there's anything that interests you. You can also reach out to us on the project's issue tracker or through email if you have any questions or need help getting started.

Getting started ✍🏻

If you're new to open source and don't know where to start, don't worry! We've tried to make it as easy as possible to contribute to the project.

Here are some steps you can follow:

  • Fork the project to your own GitHub account.
  • Clone the forked project to your local machine.
  • Make changes to the code or documentation.
  • Test the changes you have made.
  • Commit your changes and push them to your forked repository.
  • Submit a pull request to the main project repository.

Code of Conduct 📃

We want everyone who contributes to the project to feel welcome and respected.

Therefore, please read our code of conduct in the file code_of_conduct.md to understand the standards of behavior we expect from everyone involved in the project.

Feedback and Support 🎗️

We're always happy to hear from our contributors and users.

If you have feedback or suggestions for how we can improve the project, please let us know. You can reach out to us on the project's issue tracker or through email.

Thankyou ❤️

Thank you for your interest in the Dividend Income Investment Calculator! ❤️