Skip to content

Commit c5dafba

Browse files
author
Thomas Luijken
committed
Added guidelines and devcontainer for our opensource project
1 parent e8ece7c commit c5dafba

File tree

5 files changed

+222
-0
lines changed

5 files changed

+222
-0
lines changed

.devcontainer/Dockerfile

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
FROM jetpackio/devbox:latest
2+
3+
# Installing your devbox project
4+
WORKDIR /code
5+
USER root:root
6+
RUN mkdir -p /code && chown ${DEVBOX_USER}:${DEVBOX_USER} /code
7+
USER ${DEVBOX_USER}:${DEVBOX_USER}
8+
COPY --chown=${DEVBOX_USER}:${DEVBOX_USER} devbox.json devbox.json
9+
COPY --chown=${DEVBOX_USER}:${DEVBOX_USER} devbox.lock devbox.lock
10+
11+
12+
13+
RUN devbox run -- echo "Installed Packages."
14+
15+
RUN devbox shellenv --init-hook >> ~/.profile

.devcontainer/devcontainer.json

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
{
2+
"name": "Devbox Remote Container",
3+
"build": {
4+
"dockerfile": "./Dockerfile",
5+
"context": ".."
6+
},
7+
"customizations": {
8+
"vscode": {
9+
"settings": {},
10+
"extensions": [
11+
"jetpack-io.devbox"
12+
]
13+
}
14+
},
15+
"remoteUser": "devbox"
16+
}

CODE_OF_CONDUCT.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, gender identity and expression, level of experience,
9+
nationality, personal appearance, race, religion, or sexual identity and
10+
orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at [hello@baseflow.com](mailto:hello@baseflow.com). All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at [http://contributor-covenant.org/version/1/4][version]
72+
73+
[homepage]: http://contributor-covenant.org
74+
[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTE.md

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
Contributing to Oxybox
2+
-----
3+
4+
## What You'll Need
5+
6+
* **Git**: Essential for version control. You can find installation instructions [here](https://git-scm.com/).
7+
* **A GitHub Account**: If you don't have one, you can sign up for free [here](https://github.com/).
8+
9+
-----
10+
11+
## Getting Started with Your Development Environment
12+
13+
To make setup as smooth as possible, you have a few options for your development environment:
14+
15+
* **Devbox**: This is a pre-configured development environment that ensures you have all the necessary tools and dependencies readily available. [Link to Devbox setup instructions]
16+
* **Devcontainer**: If you use VS Code or another IDE that supports Devcontainers, you can get up and running quickly with a consistent environment.
17+
18+
If you prefer to set up your environment manually, follow these steps:
19+
20+
1. **Fork the Repository**: Go to `https://github.com/baseflow/oxybox` and fork the repository to your personal GitHub account.
21+
2. **Clone Your Fork**: On your local machine, clone your forked repository:
22+
```bash
23+
git clone git@github.com:<your_name_here>/oxybox.git
24+
```
25+
3. **Navigate to the Project Directory**:
26+
```bash
27+
cd oxybox
28+
```
29+
4. **Add Upstream Remote**: To keep your fork synchronized with the original Oxybox repository, add it as an upstream remote:
30+
```bash
31+
git remote add upstream https://github.com/baseflow/oxybox.git
32+
```
33+
34+
-----
35+
36+
## Contributing to Oxybox
37+
38+
We highly appreciate contributions via GitHub pull requests\! Here's how to contribute:
39+
40+
1. **Sync with Upstream**: Before you start, make sure your local `main` branch is up-to-date with the latest changes from the original repository:
41+
42+
```bash
43+
git fetch upstream
44+
git checkout main
45+
git merge upstream/main
46+
```
47+
48+
2. **Create a New Branch**: Create a new branch for your changes. Use a descriptive name that reflects the purpose of your contribution:
49+
50+
```bash
51+
git checkout -b <your-feature-or-fix-branch-name>
52+
```
53+
54+
3. **Make Your Changes**: Implement your features or bug fixes.
55+
56+
4. **Test Your Changes**: Since Oxybox is written in Rust, you'll want to run tests to ensure your changes haven't introduced any regressions and work as expected.
57+
58+
```bash
59+
cargo test
60+
```
61+
62+
5. **Format Your Code**: Ensure your code adheres to the project's formatting standards:
63+
64+
```bash
65+
cargo fmt
66+
```
67+
68+
6. **Lint Your Code**: Run clippy to catch common mistakes and improve code quality:
69+
70+
```bash
71+
cargo clippy
72+
```
73+
74+
7. **Commit Your Changes**: Stage and commit your changes with a clear and concise commit message:
75+
76+
```bash
77+
git add .
78+
git commit -m "feat: Add a concise description of your changes"
79+
```
80+
81+
(Replace "feat:" with "fix:", "docs:", "refactor:", etc., as appropriate following conventional commits.)
82+
83+
8. **Push to Your Fork**: Push your new branch to your forked repository on GitHub:
84+
85+
```bash
86+
git push origin <your-feature-or-fix-branch-name>
87+
```
88+
89+
9. **Create a Pull Request**: Go to the Oxybox repository on GitHub (`https://github.com/baseflow/oxybox`) and click the "Compare & pull request" button.
90+
91+
Please ensure you:
92+
93+
* Fill out the pull request template completely.
94+
* Address any warnings or errors reported by `cargo clippy` and `cargo test`.
95+
96+
We're excited to see your contributions\!

LICENSE.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 Baseflow
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

0 commit comments

Comments
 (0)