Skip to content

Latest commit

 

History

History
130 lines (96 loc) · 6.19 KB

CONTRIBUTING.md

File metadata and controls

130 lines (96 loc) · 6.19 KB

Contributing guide

Want to contribute to JS-Links? Awesome! There are many ways you can contribute, see below.

Remember: Every new idea or change you want to make begins as a pull request. Start a pull request before you start work on a feature not after you finish the feature.

Landing Page

Set up instructions

First of all, this is a JavaScript project that's distributed on npmjs.org and therefore uses JavaScript tooling based on Node.js with dependencies from npm. You're going to need to have those things installed to contribute to this project.

We are going to us Git Flow as a contribution workflow for this project. So you need to have Git Flow installed on your machine.

  1. Fork the repo
  2. Clone your fork
  3. Run npm install or yarn install
  4. Run npm run dev. If everything works, then you're ready to make changes. Webpack is now watching your file system for changes
  5. Create a new branch using git flow feature start MYFEATURE
  6. If you get things working, add your changed files with git add
  7. Make sure you sync your local repo with the master and continue to recieve updates as you work on your feature. Here is how you do this

From your fork you run:

  1. Push your changes to your fork with git flow feature publish MYFEATURE. This will push your code to your remote repo and enable the contributors to get the feature from your fork
  2. Create a pull request.
  3. Iterate on the solution.
  4. Get merged! 🎉 🎊

Opening issues

Open an issue to report bugs or to propose new features.

Proposing pull requests

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.

Pull requests are very welcome. Note that if you are going to propose drastic changes, be sure to open an issue for discussion first, to make sure that your PR will be accepted before you spend effort coding it.

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 [INSERT EMAIL ADDRESS]. 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