Skip to content

Commit

Permalink
Adding info on making a small change
Browse files Browse the repository at this point in the history
  • Loading branch information
wildgirl committed Dec 14, 2023
1 parent ff44f78 commit 63ce45c
Showing 1 changed file with 14 additions and 4 deletions.
18 changes: 14 additions & 4 deletions general/documentation/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,17 +23,29 @@ Moodle is in the process of updating and modernising its [Code of Conduct](./cod

Anyone can get involved with, and add to, these resources - you don't have to be a developer or documentation aficionado. Here are a few ideas to get started:

- Make a small change such as a typo fix
- Look at our list of [good first issues](https://github.com/moodle/devdocs/labels/good%20first%20issue)
- [Migrate a document](#migrating-legacy-docs) from the legacy docs
- Fix typos and grammatical errors
- Document new Moodle features
- Mark a deprecated feature as deprecated
- Raise issues in GitHub for [features which need to be documented](https://github.com/moodle/devdocs/issues/new?assignees=&labels=documentation%2C+help+wanted%2C+enhancement&template=documentation-request.yml&title=%5Bdocs%5D+Create+documentation+for+%5BFeature%5D)
- [Triage existing issues](#triaging-issues-and-pull-requests)

If you need help, please reach out to us and we will do our best to advise you.

## Getting started
## Making a small change

To make a small change, such as a typo fix:

1. Follow the link at the bottom of the page 'Edit this page'.
2. Edit the text to make the change then click the Preview button to check it looks OK.
3. When you're happy with your edit, click the button 'Commit changes...'.
4. In the 'Commit message' field, add a short message describing the change.
5. Click 'Propose changes'.
6. If necessary, add more detail about the change.
7. Click 'Create pull request'.

## Getting started with a development environment

Our documentation is built using [Docusaurus](https://docusaurus.io), a powerful open source documentation project written in JavaScript. For more detailed information, see our [installation guide](./installation.md) to install your development environment and get started.

Expand Down Expand Up @@ -173,8 +185,6 @@ We welcome contributions to these developer resources. If you've not contributed

If you have domain-specific knowledge in an area which has outstanding documentation then the [`help wanted`](https://github.com/moodle/devdocs/labels/help%20wanted) search may give you some inspiration.

If you only wish to make a small change, you may want to use the [GitHub Edit interface](https://docs.github.com/en/repositories/working-with-files/managing-files/editing-files#editing-files-in-another-users-repository) and to open a [pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request).

## Development

### Style guidelines
Expand Down

0 comments on commit 63ce45c

Please sign in to comment.