We welcome contributions and improvements to our package! To ensure a smooth process, please follow these guidelines:
-
Fork the Repository: Start by forking this repository to your GitHub account.
-
Clone the Fork: Clone your forked repository to your local machine.
git clone https://github.com/MultiChatNetwork/<project-name>.git
-
Create a Branch: Create a new branch for your feature or bug fix.
git checkout -b FEATURE-OR-BUG-DESC
-
Make Changes: Implement your changes in the new branch.
-
Commit Changes: Commit your changes with a clear and concise commit message. Follow our best practices Commit Message!
git commit -m "Description of the feature or bug fix" -
Push Changes: Push your changes to your forked repository.
git push origin FEATURE-OR-BUG-DESC
- Open a Pull Request: Navigate to the original repository and open a pull request (PR) from your forked branch.
- Describe Your Changes: Provide a detailed description of your changes in the PR description. Include relevant issue numbers if applicable.
- Review Process: Your pull request will be reviewed by the maintainers. Please be responsive to any feedback or requests for changes.
- Merge: Once approved, your changes will be merged into the main branch.
- Code Quality: Ensure your code adheres to the existing code style and conventions.
- Tests: Add tests for any new features or bug fixes. Make sure all existing and new tests pass.
- Documentation: Update documentation as needed for any changes in functionality.
- Commits: Use clear, descriptive commit messages. Follow our best practices Commit Message!
If you need any help or have questions about contributing, feel free to open an issue or reach out to the maintainers.
Thank you for your contributions and for helping to improve our package!