Skip to content

Latest commit

 

History

History
43 lines (28 loc) · 2.41 KB

CONTRIBUTING.md

File metadata and controls

43 lines (28 loc) · 2.41 KB

Contributing to Solid Fund

Thank you for your interest in contributing to the Solid Fund project! Contributions are highly encouraged and welcome. By contributing, you can help improve the project and make it more robust and useful for the community.

Before contributing, please take a moment to review the guidelines and instructions below.

How to Contribute

Reporting Issues

If you encounter any bugs, issues, or have suggestions for improvements, please submit an issue to the issue tracker at GitHub Issues. When submitting an issue, please provide as much detail as possible, including steps to reproduce the problem, expected behavior, and any relevant error messages or screenshots.

Making Contributions

If you'd like to contribute code changes or enhancements to the Solid Fund project, follow these steps:

  1. Fork the repository to your GitHub account.
  2. Create a new branch from the main branch with a descriptive name for your contribution.
  3. Make your desired changes to the codebase.
  4. Write tests to ensure the changes work as expected and do not introduce any regressions.
  5. Commit your changes with clear and concise commit messages.
  6. Push your branch to your forked repository on GitHub.
  7. Open a pull request (PR) against the main branch of the original repository. Provide a detailed description of the changes and their purpose.
  8. Wait for feedback and engage in discussions if needed. Make any requested changes to your branch based on the feedback.
  9. Once your PR is approved, it will be merged into the main branch. Congratulations on your contribution!

Code Style and Guidelines

To maintain a consistent and readable codebase, please adhere to the following guidelines:

  • Follow the existing code style and conventions used in the project.
  • Write clear and concise code with proper documentation and comments where necessary.
  • Use meaningful variable and function names that accurately describe their purpose.
  • Write tests for any new features or changes you introduce to ensure proper functionality.
  • Ensure your code is properly formatted and free of linting errors.

Code of Conduct

When participating in this project, please abide by the Code of Conduct. Be respectful and considerate towards others and maintain a positive and inclusive environment.

License

The project is licensed under the LICENSE terms.