Contributing

August 9, 2024 ยท View on GitHub

Thank you for considering contributing to the Synapse project! Your contributions help improve the project and are greatly appreciated. Please follow the guidelines below to ensure a smooth and effective contribution process.

How to Contribute

Reporting Issues

If you encounter any bugs or have suggestions for improvements, please report them using GitHub Issues:

  1. Go to the Issues page of the repository.
  2. Check if the issue has already been reported. If not, click on "New issue".
  3. Provide a clear and concise description of the problem or suggestion. Include any relevant details or screenshots.

Suggesting Enhancements

If you have ideas for new features or enhancements:

  1. Open a new issue on the Issues page.
  2. Clearly describe the enhancement or feature request and explain why it would be valuable.

Submitting Pull Requests

To contribute code changes, please follow these steps:

  1. Fork the repository: Create a personal fork of the repository on GitHub.
  2. Clone your fork: Clone the forked repository to your local machine. 
    git clone https://github.com/<your-username>/synapse.git