Hey there, potential contributor! π We're thrilled that you're considering joining the Neighborly project. Your contributions, big or small, can make a real difference in making this vector database even more awesome.
If you've stumbled upon a bug, we'd love to know about it! Here's how you can report it effectively:
- Give your issue a clear and descriptive title π that captures the essence of the problem.
- Walk us through the exact steps πΆββοΈ to reproduce the bug. The more details, the better!
- If you have examples, code snippets, or links that demonstrate the issue, include them! π They're super helpful.
We're always looking for ways to make Neighborly even better. If you have an idea for a new feature or improvement, here's how to propose it:
- Start with a clear and descriptive title π for your suggestion.
- Describe the suggested enhancement π in step-by-step detail. Paint us a picture!
- Explain the current behavior π€ and how your suggestion would make it even better π.
If you're ready to dive in and contribute code, that's fantastic! Here are a few things to keep in mind:
- Fill out the pull request template π. It helps us understand your changes better.
- Screenshots and GIFs πΈ in your pull request are always appreciated. They help visualize the changes!
- Make sure to end all files with a newline β©οΈ. It keeps things tidy.
To keep our codebase consistent and readable, we follow these conventions:
- For commit messages, use the present tense and imperative mood. For example, "Add feature" instead of "Added feature."
- Keep the first line of commit messages to 72 characters or less.
- Follow the C# coding conventions for all C# code.
Thank you for taking the time to contribute to Neighborly. Your efforts help make this project better for everyone. If you have any questions or need assistance, feel free to reach out. Happy contributing! π