6. Contributing

👋👋 Hello! Looking to contribute to OpenShare?

We're always looking to improve OpenShare. This guide should help you get started.

making changes

We provide two npm scripts that should make creating changes to OpenShare easier.

1. npm run dev: Run this command when you will be making changes. This will start a static file server on port 8080, start watchify to automatically compile JavaScript changes, and open your browser window to the test page. The test page should always have functioning share counts, share buttons, and working integrations.

2. npm run build: Run this command after you've made your changes and checked them out on the test page. If everything seems to be working well then feel free to submit a pull request!

creating pull request

1. Fork the project, clone your fork, and configure the remotes:

   # Clone your fork of the repo into the current directory
   git clone https://github.com/<your-username>/<repo-name>
   # Navigate to the newly cloned directory
   cd <repo-name>
   # Assign the original repo to a remote called "upstream"
   git remote add upstream https://github.com/OpenShare/openshare

2. If you cloned a while ago, get the latest changes from upstream:

   git checkout master
   git pull upstream master

3. Create a new topic branch (off the main project development branch) to contain your feature, change, or fix:

   git checkout -b <topic-branch-name>

4. Locally merge (or rebase) the upstream development branch into your topic branch:

   git pull [--rebase] upstream master

5. Push your topic branch up to your fork:

   git push origin <topic-branch-name>

6. Open a Pull Request with a clear title and description.