Skip to content

Latest commit

 

History

History
182 lines (142 loc) · 6.75 KB

CONTRIBUTING.md

File metadata and controls

182 lines (142 loc) · 6.75 KB
Raw

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct, please follow it in all your interactions with the project.

Branching

Now, make sure you are forking off of/branching off of the development branch located here. This allows new and upcoming changes to be pushed to a "working" directory rather than straight to the main, production directory. For example, this is how you may contribute.

Create a fork of the repository, and run the following commands in git CLI.

git switch development
git checkout -b (issue-number)-(issue-name)

The above code switches to the development branch, and creates a new branch based on the current development branch. Then, you can create a pull request on GitHub with your forked repository, pushing the new branch onto the development branch. So an example would be below;

git checkout -b 525-slash-commands-notification-spam

Code Formatting

/**
 * An {@link AnotherClass} used for using stuff.
 * 
 * @author beanbeanjuice
 * @since v3.0.0
 */
public class ExampleClass extends AnotherClass {

  private final String exampleNotNull;
  private final String exampleNullable;
  private Integer exampleOther;
  private Boolean exampleBoolean;

  /**
   * Creates a new {@link ExampleClass}.
   * @param exampleNotNull A {@link String} that is not null.
   * @param exampleNullable A {@link String} that is nullable.
   */
  public ExampleClass(@NotNull String exampleNotNull, @Nullable String exampleNullable, @NotNull Integer exampleOther,
                      @NotNull Boolean exampleBoolean) {
    this.exampleNotNull = exampleNotNull;
    this.exampleNullable = exampleNullable;
    this.exampleOther = exampleOther;
    this.exampleBoolean = exampleBoolean;
  }

  // Overridden public methods do not need javadoc.
  @Override
  public void handle(@NotNull SomeOverriddenThing thing) {
    /* Do Stuff */
  }

  /**
   * An example method used for something.
   * @param exampleOtherNotNull A {@link String} used as another example.
   * @return A {@link Boolean} for something.
   */
  @NotNull
  public Boolean exampleMethod(@NotNull String exampleOtherNotNull) {
    return /* Something */;
  }

  // At least for now, private methods do not need javadocs.
  @NotNull
  private Boolean setExampleNotNullPrivate(@NotNull String newNotNull) {

    if (/* Condition */) {
      // One line...
      // Two lines...
    } else {
      // One line...
    }

    if (/* Condition */)
      return true;
    return false;
  }

  /**
   * @return The exampleNullable {@link String} for this object.
   */
  @Nullable
  public String getExampleNullable() {
    return exampleNullable;
  }

}
// New line at end of file.

Pull Request Process

  1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
  2. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
  3. Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent. The versioning scheme we use is SemVer.
  4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.

Code of Conduct

Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.

Our Standards

Examples of behavior that contributes to creating a positive environment include:

  • Using welcoming and inclusive language
  • Being respectful of differing viewpoints and experiences
  • Gracefully accepting constructive criticism
  • Focusing on what is best for the community
  • Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

  • The use of sexualized language or imagery and unwelcome sexual attention or advances
  • Trolling, insulting/derogatory comments, and personal or political attacks
  • Public or private harassment
  • Publishing others' private information, such as a physical or electronic address, without explicit permission
  • Other conduct which could reasonably be considered inappropriate in a professional setting

Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.

Scope

This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.

Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.

Attribution

This Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at http://contributor-covenant.org/version/1/4