Skip to content

Commit

Permalink
Merge branch 'development'
Browse files Browse the repository at this point in the history
# Conflicts:
#	package.json
  • Loading branch information
JulianWowra committed Jan 18, 2022
2 parents da1258b + 7824ca8 commit 3a3a589
Show file tree
Hide file tree
Showing 16 changed files with 547 additions and 932 deletions.
7 changes: 2 additions & 5 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -1,12 +1,9 @@
# EditorConfig is awesome: https://EditorConfig.org

# top-most EditorConfig file
root = true

[*]
indent_style = tab
indent_size = 4
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = false
insert_final_newline = false
trim_trailing_whitespace = true
insert_final_newline = true
15 changes: 1 addition & 14 deletions .eslintrc.js
Original file line number Diff line number Diff line change
Expand Up @@ -40,19 +40,6 @@ module.exports = {
'space-unary-ops': 'error',
'spaced-comment': 'error',
yoda: 'error',
'no-unused-vars': 'off',
'@typescript-eslint/naming-convention': [
'error',
{
selector: 'interface',
format: ['PascalCase'],
prefix: ['I']
},
{
selector: 'typeAlias',
format: ['PascalCase'],
prefix: ['T']
}
]
'no-unused-vars': 'off'
}
};
7 changes: 7 additions & 0 deletions .prettierrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
module.exports = {
semi: true,
trailingComma: 'none',
singleQuote: true,
printWidth: 140,
useTabs: true
};
98 changes: 23 additions & 75 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,92 +1,40 @@
# Contributing

When contributing to this repository, please first discuss the change you wish to make via issue,
email, or any other method with the owners of this repository before making a change.
**I would be happy if you can contribute to this project!** If you feel you are able to provide improvements or bug fixes by yourself, please do so by forking the repository and creating a pull request. Otherwise feel free to create an issue.

Please note we have a code of conduct, please follow it in all your interactions with the project.
## Local development

## Pull Request Process
Please use the following tools for development:

1. Ensure any install or build dependencies are removed before the end of the layer when doing a
build.
2. Update the README.md with details of changes to the interface, this includes new environment
variables, exposed ports, useful file locations and container parameters.
3. Increase the version numbers in any examples files and the README.md to the new version that this
Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you
do not have permission to do that, you may request the second reviewer to merge it for you.
- [NodeJS v16](https://nodejs.org/en/)
- [yarn](https://yarnpkg.com/)
- [.editorconfig](https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig)
- [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
- [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)

## Code of Conduct
## Commit messages

### Our Pledge
For a more understandable collaboration, please use [conventional commit messages.](https://www.conventionalcommits.org/en/v1.0.0/)

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, gender identity and expression, level of experience,
nationality, personal appearance, race, religion, or sexual identity and
orientation.
## Pull request

### Our Standards
Note the following to create a pull request.

Examples of behavior that contributes to creating a positive environment
include:
Run the linter and fix any linting problems with your code:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members
```sh
yarn run lint
```

Examples of unacceptable behavior by participants include:
Document your changes in the `CHANGELOG.md`.

* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
Create a pull request. Ideally your pull request should include these things:

### Our Responsibilities
- Tests for the things you've changed/added
- Good documentation / Comments in the code

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.
Now submit your pull request to merge from your fork to master. Then I will look at your request and if necessary suggest changes, improvements or alternatives.

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.
---

### Scope

This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.

### Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at [[email protected]]. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

### Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at [http://contributor-covenant.org/version/1/4][version]

[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/
## :heart: I thank you for wanting to contribute to this project in order to create an improvement for all users.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

Based on API version: `v9.8`

[![NPM](https://nodei.co/npm/opensensemap-client.png)](https://npmjs.org/package/opensensemap-client)

## Install

```sh
Expand Down Expand Up @@ -54,7 +56,7 @@ async function start() {
console.log(JSON.stringify(r));

// Post new sensor data
const data = [];
const data: client.PostNewMeasurementsData = [];
const authToken = 'Your senseBox token';

data.push({
Expand Down Expand Up @@ -150,4 +152,4 @@ start();

## 🤝 Contributing

Contributions, issues and feature requests are welcome!<br />Feel free to check [issues page](https://github.com/KillerJulian/opensensemap-client/issues). You can also take a look at the [contributing guide](https://github.com/KillerJulian/opensensemap-client/blob/master/CONTRIBUTING.md).
Contributions, issues and feature requests are welcome!<br />Feel free to check [issues page](https://github.com/KillerJulian/opensensemap-client/issues). You can also take a look at the [contributing guide](https://github.com/KillerJulian/opensensemap-client/blob/master/CONTRIBUTING.md).
1 change: 0 additions & 1 deletion examples/js/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,3 @@ async function start() {
}

start();

2 changes: 1 addition & 1 deletion examples/ts/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ async function start() {
console.log(JSON.stringify(r));

// Post new sensor data
const data: client.TDataPostNewMeasurements = [];
const data: client.PostNewMeasurementsData = [];
const authToken = 'Your senseBox token';

data.push({
Expand Down
20 changes: 10 additions & 10 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@
{
"name": "opensensemap-client",
"description": "The library allows and improves type-bassed working with the openSenseMap API",
"version": "1.1.2",
"description": "The library allows and improves type-based working with the openSenseMap API",
"version": "1.1.1",
"main": "./dist/index.js",
"types": "./dist/index.d.ts",
"repository": "https://github.com/KillerJulian/opensensemap-client",
"homepage": "https://killerjulian.github.io/opensensemap-client/",
"author": "KillerJulian <[email protected]>",
"license": "MIT",
"dependencies": {
"axios": "^0.21.3",
"tslib": "^2.3.1"
"axios": "0.24.0",
"tslib": "2.3.1"
},
"devDependencies": {
"@types/node": "12",
"@typescript-eslint/eslint-plugin": "4.30.0",
"@typescript-eslint/parser": "4.30.0",
"eslint": "7.32.0",
"typescript": "^4.4.2",
"typedoc": "^0.21.9"
"@types/node": "12.20.41",
"@typescript-eslint/eslint-plugin": "5.10.0",
"@typescript-eslint/parser": "5.10.0",
"eslint": "8.7.0",
"typescript": "4.5.4",
"typedoc": "0.22.11"
},
"scripts": {
"build": "yarn build:lib && yarn build:docs",
Expand Down
Loading

0 comments on commit 3a3a589

Please sign in to comment.