Welcome new contributors! First of all thank you for contributing! 👍 🎉
The ONE Programming Language is a very welcoming community. We appreciate your
ideas and your help. You need to communicate in
our discord server or pick an issue and
share your perception of the solution you have. Ensure you fork this repository.
Create a new branch to work on your contribution for better code isolation.
Now that you finished the work, don't forget again to run pre-commit.
pre-commit helps ensure code quality before creating a PR. Create the
pull request and use the description to provide context and motivation, as you
did in the issue. Otherwise, you can mention your PR in the issue that you tried
to solve. Once a pull request is created, we will verify the code and accept
your PR.
A framework for managing and maintaining multi-language pre-commit hooks.
pre-commit can be installed with pip,
curl, brew or conda.
You need to first install pre-commit and then install the pre-commit hooks
with pre-commit install. Now pre-commit will run automatically on git
commit!
If you have Python installed on your system, you can easily
install pre-commit via pip install pre-commit.
It's usually a good idea to run the hooks against all the files when adding new
hooks (usually pre-commit will only run on the changed files during git
hooks). Use pre-commit run --all-files to check all files.
To run a single hook use pre-commit run --all-files <hook_id>
To update use pre-commit autoupdate
Some of our hooks use Docker images, so you will need to have Docker installed and running in order to run all the hooks successfully.
Most of the Git hooks run straight after install but we are using Clang Format
which will need to be installed first as a dependency. As in pre-commit won't
automatically install this.
On macOS you can install Clang Format with the Homebrew package manager as
seen here.
Python is an interpreted high-level general-purpose programming language.
Python's design philosophy emphasizes code readability with its notable use of
significant indentation. pip is a package-management system written in
Python used to install and manage software packages. It connects to an online
repository of public packages, called the Python Package Index.
As I mentioned before you can use pip to install pre-commit on your system.
A linter for YAML files.
yamllint does not only check for syntax validity, but for weirdness like key
repetition and cosmetic problems such as line length, trailing spaces,
indentation, etc. You can install yamllint using pip by the command:
pip install --user yamllintA Node.js style checker and lint tool for
Markdown / CommonMark
files.
The Markdown markup language is designed to be easy to read, write, and
understand. It succeeds - and its flexibility is both a benefit and a drawback.
Many styles are possible, so formatting can be inconsistent. Some constructs
don't work well in all parsers and should be avoided. The CommonMark
specification standardizes parsers - but not authors.
markdownlint is a static analysis tool for Node.js with a library of rules
to enforce standards and consistency for Markdown files. It was inspired by -
and heavily influenced by - Mark Harrison's markdownlint for Ruby. The
initial rules, rule documentation, and test cases came directly from that
project.
To install markdownlint run:
npm install markdownlint --save-devTo run markdownlint run from within the One directory:
markdownlint -c .github/linters/.markdown-lint.ymlclang-format is a tool to automatically format C/C++/Objective-C code, so
that developers don't need to worry about style issues during code reviews. It
is highly recommended to format your changed C code before opening pull
requests, which will save you and the reviewers' time.
Like many other Version Control Systems, Git has a way to fire off custom
scripts when certain important actions occur. There are two groups of these
hooks: client-side and server-side. Client-side hooks are triggered by
operations such as committing and merging, while server-side hooks run on
network operations such as receiving pushed commits. You can use these hooks for
all sorts of reasons.
The hooks are all stored in the hooks subdirectory of the Git directory. In
most projects, that’s .git/hooks. When you initialize a new repository with
git init, Git populates the hooks directory with a bunch of example scripts,
many of which are useful by themselves; but they also document the input values
of each script. All the examples are written as shell scripts, with some
Perl thrown in, but any properly named executable scripts will work fine – you
can write them in Ruby or Python or whatever language you are familiar with.
If you want to use the bundled hook scripts, you’ll have to rename them; their
file names all end with .sample.
To enable a hook script, put a file in the hooks subdirectory of your .git
directory that is named appropriately (without any extension) and is executable.
From that point forward, it should be called.
One Docker image is now on
DockerHub!
The main goal of this image is to serve as a development environment where to
run build code and run tests, before the release of ONE.
The
README_DOCKER.md,
which is the readme file for the One repository on DockerHub, will show you
how to use this image for tests, or even as a workspace with VSCode.
You can pull the image by running:
docker pull onelangorg/oneOr build it on your machine, from within the One directory, using
Dockerfile:
docker build -f "Dockerfile" -t one:latest "."Or docker-compose.yml:
docker-compose -f "docker-compose.yml" up -d --buildThis image was built using
GitHub Actions.