Skip to content

Latest commit

 

History

History
207 lines (141 loc) · 7.59 KB

contributing.md

File metadata and controls

207 lines (141 loc) · 7.59 KB
Raw
title
Contributing

Contributing


Getting Started

Fork this respository, clone your fork and add this repository as the upstream remote.

git clone <<FORKED_REPO_URL>>
git remote add upstream https://github.com/remirror/remirror

yarn ## Install all dependencies

git checkout -b BRANCH_NAME # Checkout a branch and start working on it

To work on examples or the documentation website run:

yarn docs

Once the build completes (can take a minute the first time) navigate to http://localhost:8000 (or another port if that one is already being used).

The documentation is written using gatsby and all files and dependencies are available in the /docs/ subdirectory. To add a new dependency, you will need to add it to /docs/package.json and not the top level package.json file.


Testing

Unit tests can be run with the following commands.

yarn test # Unit Test
yarn test:e2e # Unit + Integration Tests on chrome
yarn test:watch # Incremental unit tests since the last build

Create tests inside of a __tests__/ subfolder.

For naming conventions, use the following.

  • Unit tests: *.spec.ts(x)
  • Integration tests: *.e2e.test.ts within the e2e folder

Gitflow

I recommend that while working on your code you commit early and often. You won't be judged. All worked submitted in a pull request (see following section) will be squashed into one commit before merging.

remirror has built in husky support for git hooks

  • Before each commit (lint and test changed files)
  • Before each push (lint, typecheck and test)

By default these checks are not run automatically. To enable automatic pre-commit and pre-push hooks use the following command:

yarn start:checks

To stop per-commit / per-push checks run:

yarn stop:checks

Development

First, run yarn build so the initial version of everything is built.

After your first build, you can run yarn dev to watch for changes and recompile as necessary.

If you're modifying a package and import helpers from another packages in the monorepo, ensure that the other package is referenced in the referring package's package.json file.

This project is using composite types and adding a new dependency to the project throws the build process since it's location has to explicitly be updated. Running yarn generate:json will automatically update all your project references so that the build still works. (It basically creates all the project tsconfig.prod.json files for you as can be seen here.)


Pull Request (PR) Process

Once your work is complete you'll want to create a Pull Request to share all that goodness with the rest of us.

  1. Create a pull request using the github interface. The template will automatically populate for you.
  2. Add a description and reference the issue this pull request addresses where applicable. The description will be used as the body of the git commit message since all pull request are squashed down into one commit before merging.
  3. Tick off all relevant check boxes by placing an x between the square brackets i.e. [ ] to [x].
  4. Please add a screenshot where the change is related to the user interface or design. It makes it so much easier to grasp the intentions of your work. You can use your favourite GIF screenshare tool for creating animated screenshots.
  5. Once submitted the PR will be addressed at our earliest convenience.


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

Being added as Contributor

This project is using https://allcontributors.org/ so you will be added for your contribution.

To do so from command line run the following commands.

# Add yourself where GITHUB_USERNAME is your username
yarn all-contributors add GITHUB_USERNAME doc code

# Update the readme.md
yarn all-contributors generate

Troubleshooting

If you're getting errors like ReferenceError: CodeBlockExtension is not defined but you know you've imported it, it might be because you've not added it as a dependency to the relevant package.json. Rather than throwing an error in this case, rollup (?) seems to just drop the import statement but still persist the lines where the import is used.