Skip to content

Commit

Permalink
add contributor guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
bgreni committed Jan 6, 2025
1 parent c6f1e0c commit 20a6655
Show file tree
Hide file tree
Showing 5 changed files with 78 additions and 0 deletions.
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* @bgreni
16 changes: 16 additions & 0 deletions .github/workflows/branch.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
name: Branch workflow

on:
pull_request:
branches:
- '*'

permissions:
contents: write

jobs:
test:
uses: ./.github/workflows/test.yml

package:
uses: ./.github/workflows/package.yml
17 changes: 17 additions & 0 deletions .github/workflows/package.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
name: Build the package

on:
workflow_call:

jobs:
package:
name: Package
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Run the package command
run: |
curl -ssL https://magic.modular.com | bash
source $HOME/.bash_profile
magic run mojo package emberjson -o emberjson.mojopkg
17 changes: 17 additions & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
name: Run the testing suite

on:
workflow_call:

jobs:
test:
name: Run tests
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Run the test suite
run: |
curl -ssL https://magic.modular.com | bash
source $HOME/.bash_profile
magic run test
27 changes: 27 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Contributing to EmberJson

Thank you for considering contributing to EmberJson! To help you get started and to keep things running smoothly please refer to this guide before you being contributing.

## Ways to contribute

### Submitting bugs

Please report any incorrect or unexpected behaviour in the form of a bug ticket. Please include code snippet reproducing the noted behaviour, as well any JSON input required to reproduce the issue.

### Contributing to docs and examples

Any pull requests improving documentation, or more usage examples are welcome. Including function/method documentation.

### Features and optimizations

EmberJson is still under heavy development, so I'm not against doing any drastic changes to the interfaces,
but I would recommend making a proposal first so you don't waste your time implementing changes that aren't going to be accepted.

EmberJson aims to be a relatively fast JSON implementation so any effort to improve
performance will be most welcome. Arcane sorcery is acceptable but MUST be throughouly documented
for future reference and understanding.

### Making a pull request

Once your changes are ready. Be sure to run `magic run test`
to run all the unit tests, run `magic run bench` before and after you changes to ensure you haven't introduced any major performance regressions, and `magic run format` to format your code before making a PR.

0 comments on commit 20a6655

Please sign in to comment.