Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
You can contribute in many ways:
Report bugs at https://github.com/arxlang/arx/issues.
If you are reporting a bug, please include:
- Your operating system name and version.
- Any details about your local setup that might be helpful in troubleshooting.
- Detailed steps to reproduce the bug.
Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.
Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.
arx could always use more documentation, whether as part of the official arx docs, in docstrings, or even on the web in blog posts, articles, and such.
The best way to send feedback is to file an issue at https://github.com/arxlang/arx/issues.
If you are proposing a feature:
- Explain in detail how it would work.
- Keep the scope as narrow as possible, to make it easier to implement.
- Remember that this is a volunteer-driven project, and that contributions are welcome :)
Ready to contribute? Here’s how to set up arx
for local development.
-
Fork the
arx
repo on GitHub. -
Clone your fork locally:
$ git clone [email protected]:your_name_here/arx.git
- Prepare your local development environment:
$ mamba env create --file /conda/dev.yaml
$ conda activate arx
$ pre-commit install
- Create a branch for local development:
$ git checkout -b name-of-your-bugfix-or-feature
Now you can make your changes locally.
- When you’re done making changes, check the compilation and the tests:
$ makim build.dev
$ makim tests.all
$ pre-commit run --all-files
Note: if you want to remove all the build folder before starting to build
you can run makim build.dev --clean
.
- Commit your changes and push your branch to GitHub:
$ git add .
$ git commit -m “Your detailed description of your changes.”
$ git push origin name-of-your-bugfix-or-feature
- Submit a pull request through the GitHub website.
Before you submit a pull request, check that it meets these guidelines:
- The pull request should include tests.
- If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.md.
If you want to play with Arx inside a container, there is
docker-compose
file and a Dockerfile
prepared for that.
First, create the conda environment using the following command:
$ mamba env create --file conda/containers.yaml
And activate the new environment:
$ conda activate arx-containers
Now, you can build and run the new container for playing with arx: commands:
containers-sugar build
containers-sugar run
Inside the container you can run the same makim targets, for example:
makim build.dev --clean
Note: For development, remember to install pre-commit hooks:
$ pre-commit install
This project uses semantic-release in order to cut a new release based on the commit-message.
semantic-release uses the commit messages to determine the consumer impact of changes in the codebase. Following formalized conventions for commit messages, semantic-release automatically determines the next semantic version number, generates a changelog and publishes the release.
By default, semantic-release uses Angular Commit Message
Conventions.
The commit message format can be changed with the preset
or config
options_ of the
@semantic-release/commit-analyzer
and
@semantic-release/release-notes-generator
plugins.
Tools such as commitizen or commitlint can be used to help contributors and enforce valid commit messages.
The table below shows which commit message gets you which release type
when semantic-release
runs (using the default configuration):
Commit message | Release type |
---|---|
fix(pencil): stop graphite breaking when pressure is applied |
Fix Release |
feat(pencil): add 'graphiteWidth' option |
Feature Release |
perf(pencil): remove graphiteWidth option |
Chore |
BREAKING CHANGE: The graphiteWidth option has been removed |
Breaking Release |
source: https://github.com/semantic-release/semantic-release/blob/master/README.md#commit-message-format
As this project uses the squash and merge
strategy, ensure to apply
the commit message format to the PR's title.