Skip to content

Commit 4e452e1

Browse files
committed
updated contributing.md
1 parent 2151b91 commit 4e452e1

5 files changed

Lines changed: 46 additions & 1 deletion

File tree

CODEOWNERS.md

Whitespace-only changes.

CODE_OF_CONDUCT.md

Whitespace-only changes.

CONTRIBUTING.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Contributing to Ocre's Documentation
2+
3+
We welcome contributions to our documentation! This guide (still very mucah a WIP) will help you get started with the process.
4+
5+
## Getting Started
6+
7+
1. Fork the repository.
8+
2. Clone your fork: `git@github.com:<your_username>/project-ocre.github.io.git`
9+
3. Create a new branch: `git checkout -b your-branch-name`
10+
11+
## Making Changes
12+
13+
1. Navigate to the `docs` folder and make your changes using your preferred text editor.
14+
2. Test your changes locally by running `bundle exec jekyll serve` in the project root.
15+
16+
## Submitting Changes
17+
18+
1. Commit your changes: `git commit -am 'Add a brief description of your changes'`
19+
2. Push to your fork: `git push origin your-branch-name`
20+
3. Submit a pull request (PR) to the main repository.
21+
22+
## Pull Request Guidelines
23+
24+
- Provide a clear title and description for your PR.
25+
- Link any related issues in the PR description.
26+
- Ensure your changes don't break existing documentation.
27+
- Be open to feedback and be ready to make adjustments if needed.
28+
29+
## Reporting Issues
30+
31+
If you find a problem with the documentation:
32+
33+
1. Check if the issue already exists in our [issue tracker](https://github.com/project-ocre/project-ocre.github.io/issues).
34+
2. If not, create a new issue, providing as much detail as possible.
35+
36+
## Community Guidelines
37+
38+
- Be respectful and inclusive in your language and conduct.
39+
- Help others if you can.
40+
- If you disagree, do so constructively and politely.
41+
42+
## Questions?
43+
44+
If you have any questions, feel free to [reach out](https://lfedge.slack.com/archives/C07F190CC3X) on Slack or open an issue for discussion.
45+
46+
Thank you for contributing to Ocre's documentation!

LICENSE.txt

Lines changed: 0 additions & 1 deletion
This file was deleted.

SUPPORT.md

Whitespace-only changes.

0 commit comments

Comments
 (0)