Skip to content

Commit f23b14a

Browse files
authored
repo: add CONTRIBUTING.md document (#302)
* repo: add CONTRIBUTING.md document * repo: trim CONTRIBUTING.md --------- Co-authored-by: Sebastian Alex <[email protected]>
1 parent f5212a9 commit f23b14a

File tree

1 file changed

+67
-0
lines changed

1 file changed

+67
-0
lines changed

CONTRIBUTING.md

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# Contributing to Backtrace Javascript SDK
2+
3+
First off, thanks for taking the time to contribute! ❤️
4+
5+
All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉
6+
7+
> And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:
8+
>
9+
> - Star the project
10+
> - Refer this project in your project's readme
11+
> - Mention the project at local meetups and tell your friends/colleagues
12+
13+
## Table of Contents
14+
15+
- [Code of Conduct](#code-of-conduct)
16+
- [I Have a Question](#i-have-a-question)
17+
- [I Want To Contribute](#i-want-to-contribute)
18+
- [Your First Code Contribution](#your-first-code-contribution)
19+
- [Styleguides](#styleguides)
20+
- [Commit Messages](#commit-messages)
21+
22+
## Code of Conduct
23+
24+
This project and everyone participating in it is governed by the
25+
[Sauce Labs Code of Conduct](https://docs.saucelabs.com/contributing/code-of-conduct/).
26+
By participating, you are expected to uphold this code. Please report unacceptable behavior
27+
28+
29+
## I Have a Question
30+
31+
If you have a question about setting up the SDK or using the tooling, or you believe that you found a bug,
32+
please contact us at [email protected]!
33+
34+
## I Want To Contribute
35+
36+
> ### Legal Notice
37+
>
38+
> When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.
39+
40+
### Your First Code Contribution
41+
42+
- Make sure to use `npm` version that support workspaces
43+
- Add unit tests/smoketests for your change
44+
- Run an example with your code change and check the basic functionality
45+
- If this is a public API change:
46+
- try to not introduce breaking changes if possible
47+
- update the documentation
48+
- Please follow our [styleguides](#styleguides)
49+
50+
## Styleguides
51+
52+
### Commit Messages
53+
54+
Commit message should be short and descriptive of the change. They must also include a valid prefix containing the name of the changed package(s), e.g. `sdk-core` or `node`, separated by commas. If the change is specific to a file, you may use its name in the message.
55+
56+
It is best to keep separate package changes in separate commits, if possible.
57+
58+
Valid examples of commits:
59+
60+
- `sdk-core: fix invalid ID in breadcrumb generation`
61+
- `node: add CPU type to MachineAttributeProvider.ts`
62+
- `sdk-core, node: add FileSystem.doesExist`
63+
64+
Commit messages to avoid:
65+
66+
- `sdk-core: fix error` (ambiguous message - what was the error?)
67+
- `change error message in Node on invalid breadcrumb` (missing package prefix)

0 commit comments

Comments
 (0)