Skip to content

Commit da2cae5

Browse files
Merge pull request #71 from notion-dotnet/63-add-contribution-guidelines
Add Contribution guidelines 📝
2 parents be41414 + e91398c commit da2cae5

File tree

2 files changed

+33
-1
lines changed

2 files changed

+33
-1
lines changed

CONTRIBUTION.md

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
Hello! Thank you for choosing to help contribute to this open source library. There are many ways you can contribute and help is always welcome. We simply ask that you follow the following contribution guidelines.
2+
3+
# Feature Request
4+
5+
If you'd like to make a feature request, please read this section.
6+
7+
The GitHub issue tracker is the preferred channel for library feature requests, but please respect the following restrictions.
8+
9+
- Please search for existing issues in order to ensure we don't have duplicate bugs/feature requests.
10+
- Please be respectful and considerate of others when commenting on issues.
11+
12+
# Report a Bug
13+
14+
**Note:** DO NOT include your credentials in ANY code examples, descriptions, or media you make public.
15+
16+
A software bug is a demonstrable issue in the code base. In order for us to diagnose the issue and respond as quickly as possible, please add as much detail as possible into your bug report.
17+
18+
Before you decide to create a new issue, please try the following:
19+
20+
- Check the GitHub issues tab if the identified issue has already been reported, if so, please add a +1 to the existing post.
21+
- Update to the lastest version of this code and check if the issue has already been fixed
22+
23+
# Style Guidelines & Naming Conventions
24+
25+
Generally, we follow the style guidelines as suggested by the official language. However, we ask that you conform to the styles that already exist in the library. If you wish to deviate, please explain your reasoning.
26+
27+
We have defined the .editorcofig to maintain consistent coding styles. You can use the `dotnet format` tool to lint the code locally.
28+
29+
# Code Reviews
30+
31+
If you can, please look at open PRs and review them. Give feedback and help us merge these PRs much faster! If you don't know how GitHub has some great information on how to review a Pull Request.

README.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -90,4 +90,5 @@ var complexFiler = new CompoundFilter(
9090

9191
## Contribution Guideline
9292

93-
At the moment I haven't got any specific guidelines for the project. Everyone are welcome to contribute.
93+
Hello! Thank you for choosing to help contribute to this open source library. There are many ways you can contribute and help is always welcome. You can read the detailed [Contribution Guideline](https://github.com/notion-dotnet/notion-sdk-net/blob/main/CONTRIBUTION.md) defined here - we will continue to improve it.
94+

0 commit comments

Comments
 (0)