Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
ion
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Deploy
Releases
Package Registry
Container Registry
Model registry
Operate
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Enzo Cioppettini
ion
Commits
d0eb4703
Commit
d0eb4703
authored
6 years ago
by
Michael Aaron Murphy
Browse files
Options
Downloads
Patches
Plain Diff
Add contribution guide
parent
455e5a97
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
CONTRIBUTING.md
+45
-0
45 additions, 0 deletions
CONTRIBUTING.md
with
45 additions
and
0 deletions
CONTRIBUTING.md
0 → 100644
+
45
−
0
View file @
d0eb4703
## Find an issue
First, find an area to work on within the shell or one of it's related projects.
This may be:
-
An existing issue which has been reported
-
A feature that is missing that you would like to develop
-
An issue you've discovered that you would like to fix
Once you have found something that you want to work on, submit your intent to
the issue board, either by creating an issue for an issue which does not exist,
or commenting on an issue that you are working on it.
## Test your code
Before submitting a PR, ensure that you've run your tests locally and that they
pass. This can be done by running the following two commands:
```
sh
cargo +nightly
test
--lib
&&
bash examples/run_examples/sh
```
## Format your code
In addition, format your code before submitting a PR. This will require that
you've installed the
`rustfmt`
Cargo component.
```
sh
cargo +nightly
fmt
```
Now you're ready to submit your work for review!
## Chatroom
Send an email to
[
info@redox-os.org
](
mailto:info@redox-os.org
)
to request invitation for joining
the developer chatroom for Ion. Experience with Rust is not required for contributing to Ion. There
are ways to contribute to Ion at all levels of experience, from writing scripts in Ion and reporting
issues, to seeking mentorship on how to implement solutions for specific issues on the issue board.
## Discussion
In addition to the chatroom, there's a
[
thread in the Redox forums
](
https://discourse.redox-os.org/t/ion-shell-development-discussion/682
)
that can be used for discussions relating to Ion and Ion shell development. These are mostly served
by the GitHub issue board, but general discussions can take place there instead.
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment