Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Typo fix 2 #67

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Typo fix 2 #67

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
01aba74
fixed typos
elkielki Aug 27, 2024
19202fb
fixed more typos
elkielki Aug 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ FarmData2 welcomes participation and contributions. There are many ways to contr

## Code of Conduct ##

To promote an open, welcoming, inclusive and harassment-free experience, all engagement with FarmData2 is governed by the community standards expressed in the [Contributor Covenent](CODE_OF_CONDUCT.md).
To promote an open, welcoming, inclusive and harassment-free experience, all engagement with FarmData2 is governed by the community standards expressed in the [Contributor Covenant](CODE_OF_CONDUCT.md).

## Licensing ##

Content in the FarmData2 project is released under several different licenses as described in the [LICENSE file](LICENSE.md). In addition, that file describes the rights and responsibilities of contributors with regard to the their contributed content. The licensing structure of FarmData2 is designed to ensure that FarmData2 remains free and open source while protecting both the project and it community of contributors. Please review it carefully before contributing content to FarmData2.
Content in the FarmData2 project is released under several different licenses as described in the [LICENSE file](LICENSE.md). In addition, that file describes the rights and responsibilities of contributors with regard to the their contributed content. The licensing structure of FarmData2 is designed to ensure that FarmData2 remains free and open source while protecting both the project and its community of contributors. Please review it carefully before contributing content to FarmData2.

## Connecting ##

Expand All @@ -20,13 +20,13 @@ If you are unfamiliar with [Zulip](https://zulip.com/) it is a group chat applic

There are many ways to participate in FarmData2. Some of them are listed below.

Having a running version of FarmData2 is a prerequisite for many of the forms of participation. The [Install Directions] give step by step instructions for getting FarmData2 up and running.
Having a running version of FarmData2 is a prerequisite for many of the forms of participation. The [Install Directions] give step-by-step instructions for getting FarmData2 up and running.

[Install Directions]: INSTALL.md

#### Bug Reports ####

If you are are a user of FarmData2 and discover something that doesn't seem to be working correctly you can:
If you are a user of FarmData2 and discover something that doesn't seem to be working correctly you can:

* Reach out to the community on the [Zulip Developer Stream](https://farmdata2.zulipchat.com/#narrow/stream/271292-developers) to discuss what you have found and how to proceed.
* Search the [Issue Tracker] to see if the bug has been reported already.
Expand All @@ -49,18 +49,18 @@ If you are are a user of FarmData2 and have a new feature you would like to see
The project [Issue Tracker] contains tickets describing known issues with the project. The tickets for known issues are tagged with the label "bug". Each reported bug will have a detailed description of how the bug can be observed. Gardening includes activities such as:

* Verifying or clarifying these descriptions.
* Enhance the report by providing additional information about the bug (e.g. platforms on which is is or is not seen).
* Enhance the report by providing additional information about the bug (e.g. platforms on which it is or is not seen).
* Confirming that bug does (or does not) exist in the current version.

To participate by Gardening visit the [Issue Tracker] and find something of interest to verify, enhance or clarify. Try it out in your running version of FarmData2 and add a comment to the ticket with what you find.

#### Documentation ####

Update to any of the FarmData2 documentation are welcome. If you find typos, unclear or missing steps, poorly worded explanations, or have any other suggestions for how the documentation could be improved use the [workflow](#workflow) described below to create a pull request for your suggested changes.
Updates to any of the FarmData2 documentation are welcome. If you find typos, unclear or missing steps, poorly worded explanations, or have any other suggestions for how the documentation could be improved use the [workflow](#workflow) described below to create a pull request for your suggested changes.

#### Bug Fix / Feature Implementation ####

Tickets in the [Issue Tracker] that are tagged _bug_ or _enhancement_ describe issues be fixed or new features to be added to FarmData2. The tag _good first issue_ appears on the most approachable tickets. If you find an issue to work on use the [workflow](#workflow) described below to create a pull request for your suggested bug fix or feature implementation. Information about the languages and technologies that are used in FarmdData2 and pointers to resources for learning more about them can be found in the [Technology On-boarding](#technology-on-boarding) section below.
Tickets in the [Issue Tracker] that are tagged _bug_ or _enhancement_ describe issues be fixed or new features to be added to FarmData2. The tag _good first issue_ appears on the most approachable tickets. If you find an issue to work on use the [workflow](#workflow) described below to create a pull request for your suggested bug fix or feature implementation. Information about the languages and technologies that are used in FarmData2 and pointers to resources for learning more about them can be found in the [Technology On-boarding](#technology-on-boarding) section below.

#### Other Thoughts ####

Expand All @@ -70,7 +70,7 @@ The above is not an exhaustive list of ways to participate in FarmData2. For som

Interacting with FarmData2 requires a basic familiarity with git and GitHub. FarmData2 development uses a fairly standard web technology stack including HTML, CSS, Bootstrap, JavaScript, and Vue.js. The front-end accesses FarmData2 data through the [FarmOS API](https://farmos.org/development/api/) using the [Axios](https://github.com/axios/axios) library. End-to-end and component testing is done using the [Cypress framework](https://www.cypress.io/).

If you are unfamiliar with one or more of these technologies the [ONBOARDING](ONBOARDING.md) document provides additional information about each, as well as resources and activities for learning about them.
If you are unfamiliar with one or more of these technologies, the [ONBOARDING](ONBOARDING.md) document provides additional information about each, as well as resources and activities for learning about them.

## Workflow ##

Expand All @@ -82,7 +82,7 @@ As a reference, the basic steps for working with GitHub Flow are as follows:
* Fork the _upstream_ repository to your GitHub (the _origin_).
* [Clone] the _origin_ repository to your local machine.
* Set the _upstream_ remote for your local repository to point to the _upstream_ repository.
* Create a _feature branch_ from the _main_ branch your local machine.
* Create a _feature branch_ from the _main_ branch on your local machine.
* Make the edits to the documentation or the code in your _feature branch_.
* Commit your edits.
* If the contribution reflects the work of multiple people, ensure that everyone receives attribution by [Creating a commit with multiple authors].
Expand Down
6 changes: 3 additions & 3 deletions INSTALL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Under Ubuntu Linux these tools can most easily be installed using the [apt](http

Full installation details for other platforms can be obtained from the projects themselves on the following sites:

* [Intallling git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
* [Installing git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
* [Get Docker](https://docs.docker.com/get-docker/)
* [Install Compose](https://docs.docker.com/compose/install/)

Expand Down Expand Up @@ -75,7 +75,7 @@ The FarmData2 repository contains a sample database with anonymized data from se
./setDB.bash sample
```

When this command completes there should be a `db` directory in the `docker` directory. The files in this `db` directory are a mySQL database that contain the sample data. Note that you will only need to do this step once. But the above comman can be used at any time to reset the database to its initial state.
When this command completes there should be a `db` directory in the `docker` directory. The files in this `db` directory are a mySQL database that contain the sample data. Note that you will only need to do this step once. But the above command can be used at any time to reset the database to its initial state.

#### Starting FarmData2 ####

Expand All @@ -84,7 +84,7 @@ To start FarmData2 ensure that you are in the `docker` directory in the reposito
./fd2-up.bash
```

This command will starts up the docker containers that are used by FarmData2. There will be lots of output from this command and the first time you run it, it may take a while to complete as it pulls, downloads and extracts the docker images to your machine.
This command will start up the docker containers that are used by FarmData2. There will be lots of output from this command and the first time you run it, it may take a while to complete as it pulls, downloads and extracts the docker images to your machine.

If you encounter an error similar to `Cannot start service www`, it can likely be fixed by entering the command
```
Expand Down
6 changes: 3 additions & 3 deletions LICENSE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## FarmData2 Licensing Information ##

FarmData2 is a [Free Cultural Work]. This document outlines the licenses that apply to FarmData2 and the agreement which governs contributions. Complete copies of these documents can be be found in the [licenses directory]. All copies and forks of FarmData2 must be maintained in compliance with those licenses.
FarmData2 is a [Free Cultural Work]. This document outlines the licenses that apply to FarmData2 and the agreement that governs contributions. Complete copies of these documents can be be found in the [licenses directory]. All copies and forks of FarmData2 must be maintained in compliance with those licenses.

[Free Cultural Work]: https://freedomdefined.org/Definition
[licenses directory]: licenses
Expand All @@ -11,7 +11,7 @@ Contributors retain the copyright to their intellectual property.

#### Contributions ####

All contributions to FarmData2 will be licensed as a [Free Cultural Work] using the applicable license agreements as described below. Thus, before any contribution will be accepted __the contributor must certify that they have the right to license the contributed intellectual property__ under the applicable license agreement. This is done explicitly when when a contributor completes the [Developer Certificate of Origin] when opening a Pull Request, or implicitly when posting content to any public forums of the project (for example, but not limited to, issue trackers, message boards or discussion areas).
All contributions to FarmData2 will be licensed as a [Free Cultural Work] using the applicable license agreements as described below. Thus, before any contribution will be accepted __the contributor must certify that they have the right to license the contributed intellectual property__ under the applicable license agreement. This is done explicitly when a contributor acknowledges the [Developer Certificate of Origin], when opening a Pull Request, or implicitly when posting content to any public forums of the project (for example, but not limited to, issue trackers, message boards or discussion areas).

[Developer Certificate of Origin]: https://developercertificate.org/

Expand All @@ -31,4 +31,4 @@ All other content, including code snippets posted in public forums, is licensed

Attribution of contributions to the FarmData2 repository are maintained in the logs of the git version control system. The [AUTHORS.md](AUTHORS.md) file contains a list of all contributors to the repository and is updated periodically.

Attribution of content in public forums is typically maintained by the appropriate forum (e.g. threads, usernames, cross linked issues, etc). If not however, it is the contributor's responsibility to ensure that proper attribution is made based.
Attribution of content in public forums is typically maintained by the appropriate forum (e.g. threads, usernames, cross linked issues, etc). If not however, it is the contributor's responsibility to ensure that proper attribution is made.
Loading