mirror of
https://github.com/alexgo-io/stacks.js.git
synced 2026-01-12 17:52:41 +08:00
ccd58b1adb
* docs: improves readme and contribution guidelines and adds code of conduct * Update CONTRIBUTING.md --------- Co-authored-by: max-crawford <102705427+max-crawford@users.noreply.github.com> Co-authored-by: janniks <6362150+janniks@users.noreply.github.com>
54 lines
2.9 KiB
Markdown
54 lines
2.9 KiB
Markdown
# Contributing to Stacks.js
|
||
|
||
Thank you for considering contributing to Stacks.js! We welcome any contributions, whether it's bug fixes, new features, or improvements to the existing codebase.
|
||
|
||
|
||
## Your First Pull Request
|
||
|
||
Working on your first Pull Request? You can learn how from this free video series:
|
||
|
||
[How to Contribute to an Open Source Project on GitHub](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github)
|
||
|
||
To help you get familiar with our contribution process, we have a list of [help-wanted](https://github.com/hirosystems/stacks.js/labels/help-wanted) that contain bugs that have a relatively limited scope. This is a great place to get started.
|
||
|
||
If you decide to fix an issue, please be sure to check the comment thread in case somebody is already working on a fix. If nobody is working on it at the moment, please leave a comment stating that you intend to work on it so other people don’t accidentally duplicate your effort.
|
||
|
||
If somebody claims an issue but doesn’t follow up for more than two weeks, it’s fine to take it over but you should still leave a comment. **Issues won't be assigned to anyone outside the core team**.
|
||
|
||
## Contribution Prerequisites
|
||
|
||
Before running Stacks.js, ensure that you have [NodeJS](https://nodejs.dev/) installed that includes `npm`.
|
||
|
||
If you are using a mac, we highly recommend using [Homebrew](https://brew.sh/) to install these tools.
|
||
|
||
You should also be [familiar with Git](https://docs.github.com/en/get-started/quickstart/git-and-github-learning-resources).
|
||
|
||
## Sending a Pull Request
|
||
|
||
The Stacks.js team is monitoring for pull requests. We will review your pull request and either merge it, request changes to it, or close it with an explanation.
|
||
|
||
Before submitting a pull request, please make sure the following is done:
|
||
|
||
- Fork [the repository](https://github.com/hirosystems/stacks.js)
|
||
- Navigate to the project folder
|
||
- Create your branch from `main` following [Semantic Commit Messages](https://gist.github.com/joshbuchea/6f47e86d2510bce28f8e7f42ae84c716)
|
||
- Run `npm install` in the repository root to install dependencies.
|
||
|
||
As you send a PR, please keep in mind:
|
||
|
||
1. Commit messages are reasonable for changelogs (otherwise squash commit the pull request with a single new message).
|
||
2. Important code changes are covered by automated tests.
|
||
3. Compatibility breaking changes are documented and covered by conventional commits.
|
||
|
||
## Building for production
|
||
|
||
Once you are are happy woith your code change, run these commands to be ready to send a PR
|
||
|
||
- Run `pnpm lint` to lint your code with eslint and run pritter to follow our coding guidelines
|
||
- Run `npm run test` to run unit test
|
||
- Run `npm run build` to build the Stacks.js for production
|
||
|
||
Now you are ready! When you send the PR make sure to sign the Contributor License Agreement and that all the checks are green.
|
||
|
||
We are looking forward for your PRs and working together!
|