Skip to content

Commit 312b487

Browse files
committed
Add contributing guidelines
1 parent a290d49 commit 312b487

File tree

2 files changed

+40
-3
lines changed

2 files changed

+40
-3
lines changed

CONTRIBUTING.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Contributing Guidelines
2+
3+
Thank you for considering contributing to this project! To help maintain a healthy and productive environment, please follow these basic guidelines.
4+
5+
## Creating Issues
6+
7+
Here are the minimum requirements for creating a issue on this project.
8+
**Any issue with a too vague description or inappropriate language may be closed without notice**: it often takes orders of magnitude more time to answer theses than the time it took for the author to write them.
9+
10+
### 1. Clear and Descriptive Title
11+
The title should give a quick understanding of what the issue is about.
12+
13+
Examples:
14+
- ✅ "TypeError when processing empty strings"
15+
- ✅ "Documentation unclear about parameter X usage"
16+
- ❌ "It doesn't work"
17+
- ❌ "Bad implementation"
18+
19+
### 2. Meaningful Description
20+
Your description should help others understand your issue. While the format is flexible, please make sure to convey:
21+
- What you're trying to do
22+
- What's not working as expected
23+
- Any relevant context that could help understand the situation
24+
25+
The key is being clear and providing enough information so others can understand and help you.
26+
27+
### 3. Respectful Communication
28+
Remember that open source maintainers are volunteers working on this project in their free time. Please:
29+
- Be respectful and constructive (there is no "it should be like this", or "this is bad"...)
30+
- Understand that the project spirit may not align with your expectations
31+
32+
## Submitting a Pull Request
33+
34+
Pull requests are welcome! Make sure to properly explain the changes you're proposing in an issue, especially for significant changes.

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
Equativ.RoaringBitmaps is a pure C# implementation of [RoaringBitmap](http://roaringbitmap.org).
44
-**Fully managed code!** No risk of segfaults or memory leaks due to missed disposals.
55
- 🚀 **Blazingly fast!** See [benchmarks](#performance).
6+
- **Portable**: It works everywhere where .NET is supported.
67

78
## Usage
89

@@ -36,9 +37,11 @@ Charts are generated using [chartbenchmark.net](https://chartbenchmark.net/).
3637
![Performance](Resources/bench_m1.png)
3738
(lower is better)
3839

40+
## F.A.Q.
41+
3942
### How can this be faster than the C implementation?
4043

41-
Several reasons can explain why this benchmark numbers are sometimes in favor of this implementation:
44+
There can be a few reasons:
45+
- Modern C# performs really well for this kind of workloads, it shall not be underestimated.
4246
- [Roaring.Net](https://github.com/k-wojcik/Roaring.Net) is wrapper, which means that there is a marshalling cost between C# and C.
43-
- This implementation has a few optimizations that are not present in the C implementation.
44-
- Modern C# is perform really well for this kind of workloads.
47+
- This implementation has a few optimizations that are not present in the C implementation, especially for ARM CPUs.

0 commit comments

Comments
 (0)