This repository has been archived by the owner on Apr 11, 2024. It is now read-only.
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add code of conduct and contributing guidelines
- Loading branch information
1 parent
e930c71
commit 29d0032
Showing
2 changed files
with
85 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,46 @@ | ||
# Contributor Code of Conduct | ||
|
||
As contributors and maintainers of this project, and in the interest of | ||
fostering an open and welcoming community, we pledge to respect all | ||
people who contribute through reporting issues, posting feature | ||
requests, updating documentation, submitting pull requests or patches, | ||
and other activities. | ||
|
||
We are committed to making participation in this project a | ||
harassment-free experience for everyone, regardless of level of | ||
experience, gender, gender identity and expression, sexual orientation, | ||
disability, personal appearance, body size, race, ethnicity, age, | ||
religion, or nationality. | ||
|
||
Examples of unacceptable behavior by participants include: | ||
|
||
* The use of sexualized language or imagery | ||
* Personal attacks | ||
* Trolling or insulting/derogatory comments | ||
* Public or private harassment | ||
* Publishing other's private information, such as physical or electronic | ||
addresses, without explicit permission | ||
* Other unethical or unprofessional conduct | ||
|
||
Project maintainers have the right and responsibility to remove, edit, | ||
or reject comments, commits, code, wiki edits, issues, and other | ||
contributions that are not aligned to this Code of Conduct, or to ban | ||
temporarily or permanently any contributor for other behaviors that they | ||
deem inappropriate, threatening, offensive, or harmful. | ||
|
||
By adopting this Code of Conduct, project maintainers commit themselves | ||
to fairly and consistently applying these principles to every aspect of | ||
managing this project. Project maintainers who do not follow or enforce | ||
the Code of Conduct may be permanently removed from the project team. | ||
|
||
This Code of Conduct applies both within project spaces and in public | ||
spaces when an individual is representing the project or its community. | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may | ||
be reported by contacting a project maintainer at <opensource@shopify.com>. | ||
All complaints will be reviewed and investigated and will result in a response | ||
that is deemed necessary and appropriate to the circumstances. Maintainers are | ||
obligated to maintain confidentiality with regard to the reporter of an incident. | ||
|
||
This Code of Conduct is adapted from the Contributor Covenant, version | ||
1.3.0, available from http://contributor-covenant.org/version/1/3/0/ |
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,39 @@ | ||
# Contributing | ||
|
||
We welcome your contributions to the project. There are a few steps to take when looking to make a contribution. | ||
|
||
- Open an issue to discuss the feature/bug | ||
- If feature/bug is deemed valid then fork repo. | ||
- Implement patch to resolve issue. | ||
- Include tests to prevent regressions and validate the patch. | ||
- Update the docs for any API changes. | ||
- Submit a pull request. | ||
|
||
# Bug Reporting | ||
|
||
Shopify Admin API Library for Node uses GitHub issue tracking to manage bugs, please open an issue there. | ||
|
||
# Feature Request | ||
|
||
You can open a new issue on the GitHub issues and describe the feature you would like to see. | ||
|
||
# Developing the library | ||
|
||
Requirements: | ||
|
||
- [Node](https://nodejs.org/en/) v14 or above | ||
- [Yarn](https://yarnpkg.com/) v1.22 or above | ||
|
||
You can set up your development environment by running the following: | ||
|
||
``` | ||
git clone git@github.com:Shopify/shopify-node-api.git # get the code | ||
cd shopify-node-api # change into the source directory | ||
yarn install # install dependencies | ||
yarn build # build library | ||
``` | ||
|
||
Helpful commands | ||
|
||
- `yarn lint` will run linting to make sure your code is of high standard | ||
- `yarn test` will run testing to ensure your code is covered by test cases |