-
-
Notifications
You must be signed in to change notification settings - Fork 2.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
7ee87f7
commit 096a255
Showing
6 changed files
with
297 additions
and
276 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| jbrown2 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,26 +1,13 @@ | ||
| <!--- | ||
| Thanks for filing a pull request 😄 ! Before you submit, please read the following: | ||
| <!-- Provide a summary of your changes in the title field above --> | ||
|
|
||
| Search open/closed issues before submitting since someone might have pushed the same thing before! | ||
| --> | ||
| ## Motivation | ||
|
|
||
| # ↪️ Pull Request | ||
| Provide relevant context and motivation behind the change, if any | ||
|
|
||
| <!--- | ||
| Provide a general summary of the pull request here | ||
| Please look for any issues that this PR resolves and tag them in the PR. | ||
| --> | ||
| ## Changes | ||
|
|
||
| ## 💻 Examples | ||
| Describe the solution and changes you have made | ||
|
|
||
| <!-- Examples help us understand the requested feature better --> | ||
| ## Checklist | ||
|
|
||
| ## 🚨 Test instructions | ||
|
|
||
| <!-- In case it is impossible (or too hard) to reliably test this feature/fix with unit tests, please provide test instructions! --> | ||
|
|
||
| ## ✔️ PR Todo | ||
|
|
||
| - [ ] Added/updated unit tests for this change | ||
| - [ ] Filled out test instructions (In case there aren't any unit tests) | ||
| - [ ] Included links to related issues/PRs | ||
| - [ ] Existing or new tests cover this change |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,73 +1,27 @@ | ||
| # Contributor Covenant Code of Conduct | ||
| # Contributor Code of Conduct | ||
|
|
||
| ## Our Pledge | ||
| As contributors and maintainers of this project, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities. | ||
|
|
||
| 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, | ||
| education, socio-economic status, 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 | ||
| We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, or nationality. | ||
|
|
||
| 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 | ||
| * The use of sexualized language or imagery | ||
| * Personal attacks | ||
| * Trolling or insulting/derogatory comments | ||
| * 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 | ||
| * Publishing other's private information, such as physical or electronic addresses, without explicit permission | ||
| * Submitting contributions or comments that you know to violate the intellectual property or privacy rights of others | ||
| * Other unethical or unprofessional conduct | ||
|
|
||
| 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 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. | ||
| By adopting this Code of Conduct, project maintainers commit themselves to fairly and consistently applying these principles to every aspect of managing this project. Project maintainers who do not follow or enforce the Code of Conduct may be permanently removed from the project team. | ||
|
|
||
| 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. | ||
| This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. | ||
|
|
||
| ## Attribution | ||
| Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting a project maintainer. Complaints will result in a response and be reviewed and investigated in a way that is deemed necessary and appropriate to the circumstances. Maintainers are obligated to maintain confidentiality with regard to the reporter of an incident. | ||
|
|
||
| This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, | ||
| available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html | ||
| This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.3.0, available at [http://contributor-covenant.org/version/1/3/0/][version] | ||
|
|
||
| [homepage]: https://www.contributor-covenant.org | ||
| [homepage]: http://contributor-covenant.org | ||
| [version]: http://contributor-covenant.org/version/1/3/0 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,135 +1,22 @@ | ||
| # Contributing | ||
| # Contributing to Atlaspack | ||
|
|
||
| Welcome, we really appreciate if you're considering to contribute, the joint effort of our contributors make projects like this possible! | ||
| Thank you for considering a contribution to Atlaspack! Unfortunately pull requests, issues and comments are not being accepted outside of Atlassian at this time. | ||
|
|
||
| The goal of this document is to provide guidance on how you can get involved. | ||
| --- | ||
|
|
||
| ## Asking questions | ||
| For pull requests, please: | ||
|
|
||
| Have a question or feature request? Rather than opening an issue, use the [Discussions](https://github.com/parcel-bundler/parcel/discussions) board. | ||
| * Add tests for new features and bug fixes | ||
| * Follow the existing style | ||
| * Separate unrelated changes into multiple pull requests | ||
|
|
||
| Please be polite and take the time to write a well-worded question so our community members can easily assist you. | ||
| See the existing issues for things to start contributing. | ||
|
|
||
| ## Prerequisites | ||
| For bigger changes, please make sure you start a discussion first by creating an issue and explaining the intended change. --> | ||
|
|
||
| Before starting make sure you have the following installed: | ||
| Atlassian requires contributors to sign a Contributor License Agreement, known as a CLA. This serves as a record stating that the contributor is entitled to contribute the code / documentation / translation to the project and is willing to have it used in distributions and derivative works (or is willing to transfer ownership). | ||
|
|
||
| - [git](https://git-scm.com) | ||
| - [Node](https://nodejs.org) at LTS | ||
| - [Yarn](https://yarnpkg.com) at v1 | ||
| - [Rust](https://www.rust-lang.org/tools/install) stable | ||
| - [Flow](https://flow.org/en/docs/editors) IDE autocompletion and type-checking | ||
| Prior to accepting your contributions we ask that you please follow the appropriate link below to digitally sign the CLA. The Corporate CLA is for those who are contributing as a member of an organization and the individual CLA is for those contributing as an individual. | ||
|
|
||
| ## Getting started | ||
|
|
||
| In order to make it easier to get familiar with the codebase we labeled simpler issues using [Good First Issue](https://github.com/parcel-bundler/parcel/issues?q=is%3Aopen+is%3Aissue+label%3A%22%E2%9C%A8+Parcel+2%22+label%3A%22%3Ababy%3A+Good+First+Issue%22) and [Help Wanted](https://github.com/parcel-bundler/parcel/issues?q=is%3Aopen+is%3Aissue+label%3A%22%E2%9C%A8+Parcel+2%22+label%3A%22%3Apray%3A+Help+Wanted%22). You can learn the internals by reading the [documentation](https://parceljs.org/docs) or by starting from `packages/core/core/src/Parcel.js` | ||
|
|
||
| ## Pull requests | ||
|
|
||
| For significant changes, it is recommended that you first [propose your solution](https://github.com/parcel-bundler/parcel/discussions) and gather feedback. | ||
|
|
||
| **Before submitting a pull request,** you can follow this step by step guide: | ||
|
|
||
| 1. [Fork](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo) the repository and setup a new branch to work in. | ||
|
|
||
| > It's important that the changes are made in separate branches to ensure a pull request only includes the commits related to a bug or feature. | ||
| 2. Run `yarn` and `yarn build-native` in the repository root to install dependencies. | ||
| 3. If you fix a bug or introduce a new feature, add tests or ask for help if the use-case is more complex. | ||
| 4. Commit the `yarn.lock` file if it has changed. | ||
| 5. Check the steps used in [ci](https://github.com/parcel-bundler/parcel/blob/v2/.github/workflows/ci.yml) pass locally. | ||
|
|
||
| ```sh | ||
| $ yarn build-ts | ||
| $ yarn flow check | ||
| $ yarn lint | ||
| $ yarn test | ||
| ``` | ||
|
|
||
| ⚠️ Don't modify the `package.json` versioning | ||
|
|
||
| Once you are ready to create a pull request, provide relevant details about the change; examples; and test cases. All submissions require review, so please be patient! | ||
|
|
||
| ## Development workflow | ||
|
|
||
| The following commands are available: | ||
|
|
||
| - `yarn build-ts` generates the TypeScript type definitions. | ||
| - `yarn flow check` runs the [Flow](https://flow.org) type checking. | ||
| - `yarn format` keeps the code formatting consistent. | ||
| - `yarn lint` checks for stylistic or unwanted errors. | ||
| - `yarn test` runs all the unit and integration tests. | ||
| - `yarn test:integration` runs the integration tests. | ||
| - `yarn test:unit` runs the unit tests. | ||
|
|
||
| ### Debugging | ||
|
|
||
| Both VSCode and CLion can be used to debug commands such as the integration test suite. | ||
|
|
||
| - **CLion** is well supported, using default configurations for the relevant language. | ||
| - **VSCode** users can use the JavaScript Debug Terminal or Node.js launch configuration to debug JavaScript. Rust debugging requires a [LLDB](https://lldb.llvm.org/) powered launch configuration, which is available by installing the [CodeLLDB](https://marketplace.visualstudio.com/items?itemName=vadimcn.vscode-lldb) extension. | ||
|
|
||
| **Breakpoints not triggering?** Try passing in `PARCEL_WORKERS=0` to make all code run on the main thread, instead of in worker processes. Similarly, you can set `PARCEL_MAX_CONCURRENT_CALLS` to change the limit of concurrent calls per worker. | ||
|
|
||
| ### Plugins | ||
|
|
||
| When developing plugins, you should disable caching with the `--no-cache` CLI or `shouldDisableCache: true` Parcel option. This will ensure you do not see stale or incomplete results. | ||
|
|
||
| ### Working from an example | ||
|
|
||
| _Please don't commit these examples._ | ||
|
|
||
| You can create a temporary example for debugging in the folder `packages/examples`. Start by copying the `simple` example and try to reproduce the bug. It has everything setup for working on local changes and you can run `yarn build` to build the project. If you're re-using another example or creating one from scratch, make sure to use the `--no-cache` flag for `parcel build` to see your local changes reflected. | ||
|
|
||
| ### Testing outside of the monorepo | ||
|
|
||
| You can run `/path/to/monorepo/packages/core/parcel/src/bin.js build src/index.html` provided that you don't have any `@parcel/*` plugins installed in this project. | ||
|
|
||
| ## Releasing a new version | ||
|
|
||
| When releasing a new version of Parcel a couple steps should be followed: | ||
|
|
||
| 1. Run `yarn tag:prerelease 2.0.0-alpha.1` or `yarn tag:release 2.4.5` based on whether it is a prerelease (alpha, beta, nightly, ...) or a stable release | ||
| 2. Open a PR (or commit directly to the default branch) | ||
| 3. Wait for the PR to get merged | ||
| 4. Create a [GitHub release](https://github.com/parcel-bundler/parcel/releases) and publish it (this should automatically trigger an npm release, with the current state of the default branch and versions defined in the `package.json` files) | ||
|
|
||
| After these steps are completed there should be a new version of Parcel published on npm. | ||
|
|
||
| In case the automatic npm release failed, or you want to do a manual release for any other reason you can also run `yarn run release` | ||
|
|
||
| ## Become a backer or sponsor | ||
|
|
||
| Showing appreciation makes us happy, donations help us grow. | ||
|
|
||
| Our financial situation is fully transparent on our [open collective](https://opencollective.com/parcel). | ||
|
|
||
| Anyone can file an expense. If the expense makes sense for the development of the community, it will be "merged" in the ledger of our open collective by the core contributors and the person who filed the expense will be reimbursed. | ||
|
|
||
| ## Credits | ||
|
|
||
| ### Contributors | ||
|
|
||
| Thank you to all the people who have already contributed to parcel! | ||
| <a href="https://github.com/parcel-bundler/parcel/graphs/contributors"><img src="https://opencollective.com/parcel/contributors.svg?width=890" /></a> | ||
|
|
||
| ### Backers | ||
|
|
||
| Thank you to all our backers! [[Become a backer](https://opencollective.com/parcel#backer)] | ||
|
|
||
| <a href="https://opencollective.com/parcel#backers" target="_blank"><img src="https://opencollective.com/parcel/backers.svg?width=890"></a> | ||
|
|
||
| ### Sponsors | ||
|
|
||
| Thank you to all our sponsors! (please ask your company to also support this open source project by [becoming a sponsor](https://opencollective.com/parcel#sponsor)) | ||
|
|
||
| <a href="https://opencollective.com/parcel/sponsor/0/website" target="_blank"><img src="https://opencollective.com/parcel/sponsor/0/avatar.svg"></a> | ||
| <a href="https://opencollective.com/parcel/sponsor/1/website" target="_blank"><img src="https://opencollective.com/parcel/sponsor/1/avatar.svg"></a> | ||
| <a href="https://opencollective.com/parcel/sponsor/2/website" target="_blank"><img src="https://opencollective.com/parcel/sponsor/2/avatar.svg"></a> | ||
| <a href="https://opencollective.com/parcel/sponsor/3/website" target="_blank"><img src="https://opencollective.com/parcel/sponsor/3/avatar.svg"></a> | ||
| <a href="https://opencollective.com/parcel/sponsor/4/website" target="_blank"><img src="https://opencollective.com/parcel/sponsor/4/avatar.svg"></a> | ||
| <a href="https://opencollective.com/parcel/sponsor/5/website" target="_blank"><img src="https://opencollective.com/parcel/sponsor/5/avatar.svg"></a> | ||
| <a href="https://opencollective.com/parcel/sponsor/6/website" target="_blank"><img src="https://opencollective.com/parcel/sponsor/6/avatar.svg"></a> | ||
| <a href="https://opencollective.com/parcel/sponsor/7/website" target="_blank"><img src="https://opencollective.com/parcel/sponsor/7/avatar.svg"></a> | ||
| <a href="https://opencollective.com/parcel/sponsor/8/website" target="_blank"><img src="https://opencollective.com/parcel/sponsor/8/avatar.svg"></a> | ||
| <a href="https://opencollective.com/parcel/sponsor/9/website" target="_blank"><img src="https://opencollective.com/parcel/sponsor/9/avatar.svg"></a> | ||
| * [CLA for corporate contributors](https://opensource.atlassian.com/corporate) | ||
| * [CLA for individuals](https://opensource.atlassian.com/individual) |
Oops, something went wrong.