Sitelet https://github.com/open-rpc/client-js/commit/de17561
Skip to content

Commit de17561

Browse files
BelfordZBelfordZ
committed
feat: initial commit
0 parents  commit de17561

8 files changed

Lines changed: 606 additions & 0 deletions

File tree

‎.gitignore‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
./build
2+
./**/build

‎BUILDING.md‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
# Jade Project Building
2+
3+
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in [BCP 14](https://tools.ietf.org/html/bcp14) [RFC2119](https://tools.ietf.org/html/rfc2119) [RFC8174](https://tools.ietf.org/html/rfc8174) when, and only when, they appear in all capitals, as shown here.
4+
5+
This document is licensed under [The Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0.html).
6+
7+
When using the name 'version' we mean the versioning scheme described in [VERSIONING.md](VERSIONING.md)
8+
9+
## Introduction
10+
11+
This document is to describe the functionality a jade project MUST provide in terms of creating build artifacts. It also describes the structure in which jade project's MUST write build artifacts in.
12+
13+
We propose:
14+
- a folder name convention for build artifacts
15+
- a folder structure for the above-mentioned build artifacts folder
16+
- a list of platforms we will target
17+
- Using docker-compose with a service for each build target
18+
- a build pipeline given the above pretext
19+
20+
The purpose of having a uniform way of producing a build is that we may ALL produce builds for any of the projects, making the onramp for new developers less steep, while still maintaining an exceptionally high level of quality.
21+
22+
Further, the projects should adhere to the principles of 'architecture as code' - and should require a very minimal set of dependencies in order to contribute. That said, we have chose to center around docker for creating builds. Windows builds may be created using `wine`. If Wine is not an option, the standard may be broken to accomodate such cases.
23+
24+
It is the responsibilty of the build tooling to write artifacts to the appropriate location as outlined in this specification.
25+
26+
## Build Folder Name
27+
The cannonical folder for builds SHALL be named `build` and be located at the root of the project repository.
28+
Each project MUST `git ignore` the `build` folder.
29+
30+
## Build Folder Structure
31+
Files and folder names MUST be lowercase.
32+
The result of the build process should create a folder structure as follows:
33+
```
34+
.
35+
└── build
36+
└── {platform}
37+
└── {project-name}.{ext}
38+
```
39+
40+
41+
Below is an example:
42+
```
43+
.
44+
└── build
45+
└── windows
46+
└── jade-signer.{ext}
47+
```
48+
49+
## Build Platform Targets
50+
Below is a list of platforms we will target for each project
51+
1. windows
52+
2. linux
53+
3. mac
54+
55+
## Docker-compose to create a build
56+
Each project MUST have a /docker-compose.build.yml file.
57+
The result of this is that every project MUST produce a build for each target platform when the following command is invoked:
58+
- `docker-compose up -f ./docker-compose.build.yml`
59+
60+
The docker-compose.build.yml file MUST be placed in the project's root directory.
61+
Any dockerfiles used by the docker-compose may be placed at the discretion of the developer of the jade project.
62+
63+
## Build Pipeline
64+
Starting from clean master branch with latest HEAD
65+
66+
### building all targets
67+
`docker-compose up -f ./docker-compose.build.yml` should create builds for each of the targeted platforms, and place the build artifacts in a folder structure outlined above.
68+
69+
### building specific target
70+
`docker-compose up -f ./docker-compose.build.yml [windows | linux | mac]`
71+
72+
Thats it.

‎CONTRIBUTING.md‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# Contributing
2+
3+
> This document is inspired by [elasticsearch/CONTRIBUTING.md](https://github.com/elastic/elasticsearch/blob/master/CONTRIBUTING.md)
4+
5+
There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, [submitting github issues](https://help.github.com/articles/creating-an-issue/), bug reports, feature requests and writing code.
6+
7+
## License
8+
9+
This repository uses the [The Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0.html).
10+
11+
## Bug reports
12+
13+
If you think you've found a bug in the software, first make sure you're testing against the *latest* version of the software -- your issue may have been fixed already. If it's not, please check out the issues list on github and search for similar issues that have already been opened. If there are no issues then please [submit a github issue](https://help.github.com/articles/creating-an-issue/).
14+
15+
If you can provide a small test case it would greately help the reproduction of a bug, as well as a a screenshot, and any other information you can provide.
16+
17+
18+
## Feature Requests
19+
20+
If there are features that do not exist yet, we are definitely open to feature requests and detailed proposals. [Open an issue](https://help.github.com/articles/creating-an-issue/) on our Github which describes the feature or proposal in detail, answer questions like why? how?
21+
22+
## Contributing Code and Documentation Changes
23+
24+
Bug fixes, patches and new features are welcome. Please find or open an issue about it first. Talk about what exactly want to do, someone may already be working on it, or there might be some issues that you need to be aware of before implementing the fix.
25+
26+
There are many ways to fix a problem and it is important to find the best approach before writing a ton of code.
27+
28+
### Cloning (or forking) the repository
29+
30+
First off, you are going to need your own copy of the repository. You can find help on how to fork a repo [here](https://help.github.com/articles/fork-a-repo/).
31+
32+
### Submitting your changes
33+
34+
1. Review & Test your changes
35+
36+
If it's code: make sure you test it. If it's documentation: make sure you view it in a Markdown viewer or the like.
37+
38+
2. Commiting
39+
40+
Follow the [Convention Commits](CONVENTIONAL_COMMITS.md) guidelines to create a commit message
41+
42+
43+
3. Sign the CLA
44+
45+
Make sure you've signed the repository's Contributor License Agreement. We are not asking you to assign copyright to us, but to give us the right to distribute your code without restriction. We ask this of all contributors in order to assure our users of the origin and continuing existence of the code. You only need to sign the CLA once.
46+
47+
48+
4. Submit a pull request
49+
50+
Push your local changes to you forked repository and make a pull request. Follow the [Convention Commits](CONVENTIONAL_COMMITS.md) guidelines for naming Github pull requests and what to put in the body.
51+
52+
53+
## Building
54+
55+
Follow the build process is outlined in [the BUILDING spec](BUILDING.md) to create a build.
56+
57+
58+
## Releasing
59+
60+
Follow the release process is outlined in [the RELEASING spec](RELEASING.md) to create a release.
61+
62+

‎CONVENTIONAL_COMMITS.md‎

Lines changed: 168 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,168 @@
1+
# Conventional Commits 1.0.0-beta.2
2+
3+
> This spec is a direct copied here from [http://conventionalcommits.org](http://conventionalcommits.org). It lives here as a reference documentation for new contributors.
4+
5+
## Summary
6+
7+
The [Conventional Commits](http://conventionalcommits.org) specification is a lightweight convention on top of commit messages.
8+
It provides an easy set of rules for creating an explicit commit history;
9+
which makes it easier to write automated tools on top of.
10+
This convention dovetails with [SemVer](http://semver.org),
11+
by describing the features, fixes, and breaking changes made in commit messages.
12+
13+
The commit message should be structured as follows:
14+
15+
---
16+
17+
```
18+
<type>[optional scope]: <description>
19+
20+
[optional body]
21+
22+
[optional footer]
23+
```
24+
---
25+
26+
<br />
27+
The commit contains the following structural elements, to communicate intent to the
28+
consumers of your library:
29+
30+
1. **fix:** a commit of the _type_ `fix` patches a bug in your codebase (this correlates with [`PATCH`](http://semver.org/#summary) in semantic versioning).
31+
1. **feat:** a commit of the _type_ `feat` introduces a new feature to the codebase (this correlates with [`MINOR`](http://semver.org/#summary) in semantic versioning).
32+
1. **BREAKING CHANGE:** a commit that has the text `BREAKING CHANGE:` at the beginning of its optional body or footer section introduces a breaking API change (correlating with [`MAJOR`](http://semver.org/#summary) in semantic versioning).
33+
A BREAKING CHANGE can be part of commits of any _type_.
34+
1. Others: commit _types_ other than `fix:` and `feat:` are allowed, for example [commitlint-config-conventional](https://github.com/marionebl/commitlint/tree/master/%40commitlint/config-conventional) (based on the [the Angular convention](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#-commit-message-guidelines)) recommends `chore:`, `docs:`, `style:`, `refactor:`, `perf:`, `test:`, and others.
35+
We also recommend `improvement` for commits that improve a current implementation without adding a new feature or fixing a bug.
36+
Notice these types are not mandated by the conventional commits specification, and have no implicit effect in semantic versioning (unless they include a BREAKING CHANGE).
37+
<br />
38+
A scope may be provided to a commit's type, to provide additional contextual information and is contained within parenthesis, e.g., `feat(parser): add ability to parse arrays`.
39+
40+
## Examples
41+
42+
### Commit message with description and breaking change in body
43+
```
44+
feat: allow provided config object to extend other configs
45+
46+
BREAKING CHANGE: `extends` key in config file is now used for extending other config files
47+
```
48+
49+
### Commit message with no body
50+
```
51+
docs: correct spelling of CHANGELOG
52+
```
53+
54+
### Commit message with scope
55+
```
56+
feat(lang): added polish language
57+
```
58+
59+
### Commit message for a fix using an (optional) issue number.
60+
```
61+
fix: minor typos in code
62+
63+
see the issue for details on the typos fixed
64+
65+
fixes issue #12
66+
```
67+
## Specification
68+
69+
The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in [RFC 2119](https://www.ietf.org/rfc/rfc2119.txt).
70+
71+
1. Commits MUST be prefixed with a type, which consists of a noun, `feat`, `fix`, etc., followed by a colon and a space.
72+
1. The type `feat` MUST be used when a commit adds a new feature to your application or library.
73+
1. The type `fix` MUST be used when a commit represents a bug fix for your application.
74+
1. An optional scope MAY be provided after a type. A scope is a phrase describing a section of the codebase enclosed in parenthesis, e.g., `fix(parser):`
75+
1. A description MUST immediately follow the type/scope prefix.
76+
The description is a short description of the code changes, e.g., _fix: array parsing issue when multiple spaces were contained in string._
77+
1. A longer commit body MAY be provided after the short description, providing additional contextual information about the code changes. The body MUST begin one blank line after the description.
78+
1. A footer MAY be provided one blank line after the body.
79+
The footer SHOULD contain additional issue references about the code changes (such as the issues it fixes, e.g.,`Fixes #13`).
80+
1. Breaking changes MUST be indicated at the very beginning of the footer or body section of a commit. A breaking change MUST consist of the uppercase text `BREAKING CHANGE`, followed by a colon and a space.
81+
1. A description MUST be provided after the `BREAKING CHANGE: `, describing what has changed about the API, e.g., _BREAKING CHANGE: environment variables now take precedence over config files._
82+
1. The footer MUST only contain `BREAKING CHANGE`, external links, issue references, and other meta-information.
83+
1. Types other than `feat` and `fix` MAY be used in your commit messages.
84+
85+
## Why Use Conventional Commits
86+
87+
* Automatically generating CHANGELOGs.
88+
* Automatically determining a semantic version bump (based on the types of commits landed).
89+
* Communicating the nature of changes to teammates, the public, and other stakeholders.
90+
* Triggering build and publish processes.
91+
* Making it easier for people to contribute to your projects, by allowing them to explore
92+
a more structured commit history.
93+
94+
## FAQ
95+
96+
### How should I deal with commit messages in the initial development phase?
97+
98+
We recommend that you proceed as if you've an already released product. Typically *somebody*, even if its your fellow software developers, is using your software. They'll want to know what's fixed, what breaks etc.
99+
100+
### Are the types in the commit title uppercase or lowercase?
101+
102+
Any casing may be used, but it's best to be consistent.
103+
104+
### What do I do if the commit conforms to more than one of the commit types?
105+
106+
Go back and make multiple commits whenever possible. Part of the benefit of Conventional Commits is its ability to drive us to make more organized commits and PRs.
107+
108+
### Doesn’t this discourage rapid development and fast iteration?
109+
110+
It discourages moving fast in a disorganized way. It helps you be able to move fast long term across multiple projects with varied contributors.
111+
112+
### Might Conventional Commits lead developers to limit the type of commits they make because they'll be thinking in the types provided?
113+
114+
Conventional Commits encourages us to make more of certain types of commits such as fixes. Other than that, the flexibility of Conventional Commits allows your team to come up with their own types and change those types over time.
115+
116+
### How does this relate to SemVer?
117+
118+
`fix` type commits should be translated to `PATCH` releases. `feat` type commits should be translated to `MINOR` releases. Commits with `BREAKING CHANGE` in the commits, regardless of type, should be translated to `MAJOR` releases.
119+
120+
### How should I version my extensions to the Conventional Commits Specification, e.g. `@jameswomack/conventional-commit-spec`?
121+
122+
We recommend using SemVer to release your own extensions to this specification (and
123+
encourage you to make these extensions!)
124+
125+
### What do I do if I accidentally use the wrong commit type?
126+
127+
#### When you used a type that's of the spec but not the correct type, e.g. `fix` instead of `feat`
128+
129+
Prior to merging or releasing the mistake, we recommend using `git rebase -i` to edit the commit history. After release, the cleanup will be different according to what tools and processes you use.
130+
131+
#### When you used a type *not* of the spec, e.g. `feet` instead of `feat`
132+
133+
In a worst case scenario, it's not the end of the world if a commit lands that does not meet the conventional commit specification. It simply means that commit will be missed by tools that are based on the spec.
134+
135+
### Do all my contributors need to use the conventional commit specification?
136+
137+
No! If you use a squash based workflow on Git lead maintainers can cleanup the commit messages as they're merged—adding no workload to casual committers.
138+
A common workflow for this is to have your git system automatically squash commits from a pull request and present a form for the lead maintainer to enter the proper git commit message for the merge.
139+
140+
## About
141+
142+
The Conventional Commit specification is inspired by, and based heavily on, the [Angular Commit Guidelines](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#-commit-message-guidelines).
143+
144+
The first draft of this specification has been written in collaboration with some of the folks contributing to:
145+
146+
* [conventional-changelog](https://github.com/conventional-changelog/conventional-changelog): a set of tools for parsing conventional commit messages from git histories.
147+
* [bumped](https://bumped.github.io): a tool for releasing software that makes it easy to perform actions before and after releasing a new version of your software.
148+
* [unleash](https://github.com/netflix/unleash): a tool for automating the software release and publishing lifecycle.
149+
* [lerna](https://github.com/lerna/lerna): a tool for managing monorepos, which grew out of the Babel project.
150+
151+
## Tooling for Conventional Commits
152+
153+
* [conform](https://github.com/autonomy/conform): a tool that can be used to enforce policies on git repositories, including conventional commits.
154+
155+
## Projects Using Conventional Commits
156+
157+
* [yargs](https://github.com/yargs/yargs): everyone's favorite pirate themed command line argument parser.
158+
* [istanbuljs](https://github.com/istanbuljs/istanbuljs): a collection of open-source tools and libraries for adding test coverage to your JavaScript tests.
159+
* [standard-version](https://github.com/conventional-changelog/standard-version): Automatic versioning and CHANGELOG management, using GitHub's new squash button and the recommended Conventional Commits workflow.
160+
* [uPortal-home](https://github.com/UW-Madison-DoIT/angularjs-portal) and [uPortal-application-framework](https://github.com/UW-Madison-DoIT/uw-frame): Optional supplemental user interface enhancing [Apereo uPortal](https://www.apereo.org/projects/uportal).
161+
* [massive.js](https://github.com/dmfay/massive-js): A data access library for Node and PostgreSQL.
162+
* [electron](https://github.com/electron/electron): Build cross-platform desktop apps with JavaScript, HTML, and CSS.
163+
* [scroll-utility](https://github.com/LeDDGroup/scroll-utility): A simple to use scroll utility package for centering elements, and smooth animations
164+
* [Blaze UI](https://github.com/BlazeUI/blaze): Framework-free open source modular toolkit.
165+
166+
[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org)
167+
168+
_want your project on this list?_ [send a pull request](https://github.com/conventional-changelog/conventionalcommits.org/pulls).

0 commit comments

Comments
 (0)