forked from serversideup/amplitudejs
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
5844110
commit 95858dd
Showing
1 changed file
with
21 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
# How to contribute | ||
- Thank them for wanting to contribute | ||
- Explain there are a few guidelines to contribute | ||
|
||
Thanks for your interest in contributing to the AmplitudeJS project! We have a few guidelines on getting started and how to contribute: | ||
|
||
## Coding Guidelines | ||
|
||
- Be friendly and respectful of other people's ideas | ||
- Make sure all code is properly indented with tabs and commented thoroughly | ||
- Everything MUST be in Vanilla JavaScript and not revolve around any library | ||
- Spend some quality time testing your code | ||
|
||
## Set Up Your Development Environment | ||
1. Clone Github repository to your machine. Use the `dev` branch to access the latest and greatest code. | ||
2. All source code is located in the `src` folder | ||
|
||
## Creating a new build of `amplitude.js` | ||
1. Change directories into where you cloned the repository and run `npm install` | ||
2. Make your changes to the appropriate files in the `src` directory | ||
3. Run `npm run build` to process a build of your source code |