Skip to content

Commit

Permalink
Documentation Updates:
Browse files Browse the repository at this point in the history 
- Created CONTRIBUTING.md for contributions, support, and issues
- Removed contributions section from README.md, reorganized remaining sections
  • Loading branch information
@mciolkosz
mciolkosz committed May 21, 2022
1 parent ee5675d commit e490c05
Show file tree
Hide file tree
Showing 2 changed files with 93 additions and 91 deletions.
61 changes: 61 additions & 0 deletions CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# Contributions, Support, and Issues for YamlConfiguration

Contributions to the project are welcome. YamlConfiguration is a free and open source software project, created in the hopes that the community would find ways to improve it.

## Contributing

### Pull Requests

If you make any improvements or other enhancements to YamlConfiguration, we ask that you submit a Pull Request to merge the changes back upstream. We would enjoy the opportunity to give those improvements back to the wider community.

Various types of contributions are welcome, including (but not limited to):
- Security updates / patches
- Bug fixes
- Feature enhancements

We reserve the right to not include a contribution in the project if the contribution does not add anything substantive or otherwise reduces the functionality of YamlConfiguration in a non-desirable way. That said, the idea of having free and open source software was that contributions would be accepted, and discussions over a potential contribution are welcome.

For licensing questions, please see the Licensing section.

### Project Layout

YamlConfiguration somewhat follows the [Google Java Style Guide](https://google.github.io/styleguide/javaguide.html). This is not the definitive coding style of the project. Generally, it is best to try to copy the style of coding found in the class that you are editing.

## Support / Issues

Issues can be reported [here in GitHub](https://github.com/bspfsystems/YamlConfiguration/issues/).

### First Steps

Before creating an issue, please search to see if anyone else has reported the same issue. Don't forget to search the closed issues. It is much easier for us (and will get you a faster response) to handle a single issue that affects multiple users than it is to have to deal with duplicates.

There is also a chance that your issue has been resolved previously. In this case, you can (ideally) find the answer to your problem without having to ask (new version of YamlConfiguration, configuration update, etc).

### Creating an Issue

If no one has reported the issue previously, or the solution is not apparent, please open a new issue. When creating the issue, please give it a descriptive title (no "It's not working", please), and put as much detail into the description as possible. The more details you add, the easier it becomes for us to solve the issue. Helpful items may include:
- A descriptive title for the issue
- The version of YamlConfiguration you are using
- Logs and/or stack traces
- Any steps to reproducing the issue
- Anything else that might be helpful in solving your issue.

_Note:_ Please redact any Personally-Identifiable Information (PII) when you create your issue. These may appear in logs or stack traces. Examples include (but are not limited to):
- Real names of people / companies
- Usernames of accounts on computers (may appear in logs or stack traces)
- IP addresses / hostnames
- etc.

If you are not sure, you can always redact or otherwise change the data.

### Non-Acceptable Issues

Issues such as "I need help" or "It doesn't work" will not be addressed and/or will be closed with no assistance given. These type of issues do not have any meaningful details to properly address the problem. Other issues that will not be addressed and/or closed without help include (but are not limited to):
- How to install YamlConfiguration (explained in README)
- How to use YamlConfiguration as a dependency (explained in README)
- How to create libraries
- How to set up a development environment
- How to install libraries
- Other issues of similar nature...

This is not a help forum for software development or associated issues. Other resources, such as [Google](https://www.google.com/), should have answers to most questions not related to YamlConfiguration.
123 changes: 32 additions & 91 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,33 @@ It is based off of [SpigotMC's Bukkit](https://hub.spigotmc.org/stash/projects/S

## Obtaining YamlConfiguration

There are multiple methods for obtaining a copy of YamlConfiguration for your project. Below are a few of the methods. The most common one is to add it as a dependency to your project via Maven, Gradle, or any other build platform. Otherwise, if you need a copy of the `.jar` file to place in a library folder, you can either build YamlConfiguration from source, or you can obtain a pre-built version from the Releases page.
You can obtain a copy of YamlConfiguration via the following methods:
- Download a pre-built copy from the [Releases page](https://github.com/bspfsystems/YamlConfiguration/releases/latest/). The latest version is release 1.2.0.
- Build from source (see below).
- Include it as a dependency in your project (see the Development API section).
-
### Build from Source

YamlConfiguration uses [Apache Maven](https://maven.apache.org/) to build and handle dependencies.

#### Requirements

- Java Development Kit (JDK) 8 or higher
- Git
- Apache Maven

#### Compile / Build

Run the following commands to build the library `.jar` file:
```
git clone https://github.com/bspfsystems/YamlConfiguration.git
cd YamlConfiguration/
mvn clean install
```

The `.jar` file will be located in the `target/` folder.

## Developer API

### Add as a Dependency

Expand All @@ -30,7 +56,6 @@ Include the following in your `pom.xml` file:<br />
<scope>compile</scope>
</dependency>
</dependencies>
...
```

**Gradle:**<br />
Expand All @@ -43,41 +68,12 @@ repositories {
}
}
...
dependencies {
include implementation("org.bspfsystems:yamlconfiguration:1.2.0")
implementation "org.bspfsystems:yamlconfiguration:1.2.0"
}
```

### Build from Source

YamlConfiguration uses [Apache Maven](https://maven.apache.org/) to build and handle dependencies.

#### Requirements

- Java Development Kit (JDK) 8 or higher
- Git
- Apache Maven

#### Compile / Build

Run the following commands to build the library `.jar` file:
```
git clone https://github.com/bspfsystems/YamlConfiguration.git
cd YamlConfiguration/
mvn clean install
```

The `.jar` file will be located in the `target/` folder.

### Download

You can download the latest version of the library from [here](https://github.com/bspfsystems/YamlConfiguration/releases/latest/).

The latest version is release 1.2.0.

## Developer API
### API Examples

These are some basic usages of YamlConfiguration; for a full scope of what the library offers, please see the Javadocs section below.
```
Expand All @@ -104,68 +100,13 @@ try {
}
```

## Javadocs
### Javadocs

The API Javadocs can be found [here](https://bspfsystems.org/docs/yamlconfiguration/), kindly hosted by [javadoc.io](https://javadoc.io/).

## Contributing

### Pull Requests

Contributions to the project are welcome. YamlConfiguration is a free and open source software project, created in the hopes that the community would find ways to improve it. If you make any improvements or other enhancements to YamlConfiguration, we ask that you submit a Pull Request to merge the changes back upstream. We would enjoy the opportunity to give those improvements back to the wider community.

Various types of contributions are welcome, including (but not limited to):
- Security updates / patches
- Bug fixes
- Feature enhancements

We reserve the right to not include a contribution in the project if the contribution does not add anything substantive or otherwise reduces the functionality of YamlConfiguration in a non-desirable way. That said, the idea of having free and open source software was that contributions would be accepted, and discussions over a potential contribution are welcome.

For licensing questions, please see the Licensing section.

### Project Layout

YamlConfiguration somewhat follows the [Google Java Style Guide](https://google.github.io/styleguide/javaguide.html). This is not the definitive coding style of the project. Generally, it is best to try to copy the style of coding found in the class that you are editing.

## Support / Issues

Issues can be reported [here in GitHub](https://github.com/bspfsystems/YamlConfiguration/issues/).

### First Steps

Before creating an issue, please search to see if anyone else has reported the same issue. Don't forget to search the closed issues. It is much easier for us (and will get you a faster response) to handle a single issue that affects multiple users than it is to have to deal with duplicates.

There is also a chance that your issue has been resolved previously. In this case, you can (ideally) find the answer to your problem without having to ask (new version of YamlConfiguration, configuration update, etc).

### Creating an Issue

If no one has reported the issue previously, or the solution is not apparent, please open a new issue. When creating the issue, please give it a descriptive title (no "It's not working", please), and put as much detail into the description as possible. The more details you add, the easier it becomes for us to solve the issue. Helpful items may include:
- A descriptive title for the issue
- The version of YamlConfiguration you are using
- Logs and/or stack traces
- Any steps to reproducing the issue
- Anything else that might be helpful in solving your issue.

_Note:_ Please redact any Personally-Identifiable Information (PII) when you create your issue. These may appear in logs or stack traces. Examples include (but are not limited to):
- Real names of people / companies
- Usernames of accounts on computers (may appear in logs or stack traces)
- IP addresses / hostnames
- etc.

If you are not sure, you can always redact or otherwise change the data.

### Non-Acceptable Issues

Issues such as "I need help" or "It doesn't work" will not be addressed and/or will be closed with no assistance given. These type of issues do not have any meaningful details to properly address the problem. Other issues that will not be addressed and/or closed without help include (but are not limited to):
- How to install YamlConfiguration (explained in README)
- How to use YamlConfiguration as a dependency (explained in README)
- How to create libraries
- How to set up a development environment
- How to install libraries
- Other issues of similar nature...

## Contributing, Support, and Issues

This is not a help forum for software development or associated issues. Other resources, such as [Google](https://www.google.com/), should have answers to most questions not related to YamlConfiguration.
Please check out [CONTRIBUTING.md](CONTRIBUTING.md) for more information.

## Licensing

Expand Down

0 comments on commit e490c05

Please sign in to comment.