forked from profectus/Profectus
32 lines
1.4 KiB
Markdown
32 lines
1.4 KiB
Markdown
|
# Contributing to Profectus
|
||
|
|
|
||
|
|
Thank you for considering contributing to Profectus! We appreciate your interest in improving our project. Please take a moment to review the following guidelines to streamline the contribution process.
|
||
|
|
|
||
|
|
## Getting Started
|
||
|
|
|
||
|
|
For detailed instructions on setting up local development environment, please refer to the [Setup Guide](https://moddingtree.com/guide/getting-started/setup).
|
||
|
|
|
||
|
|
## Contributing
|
||
|
|
|
||
|
|
Make sure to open your PR on Incremental Social - the GitHub repo is just a mirror!
|
||
|
|
|
||
|
|
### Code Review
|
||
|
|
|
||
|
|
All PRs must be reviewed and approved by at least one of the project maintainers before merging. Please be patient during the review process and be open to feedback.
|
||
|
|
|
||
|
|
### Testing
|
||
|
|
|
||
|
|
Ensure that your changes pass all existing tests and, if applicable, add new tests to cover the changes you've made. Run `npm run test` to run all the tests.
|
||
|
|
|
||
|
|
## Code Style
|
||
|
|
|
||
|
|
We use ESLint and Prettier to enforce consistent code style throughout the project. Before submitting a PR, run `npm run lint:fix` to automatically fix any linting issues.
|
||
|
|
|
||
|
|
## Issue Reporting
|
||
|
|
|
||
|
|
If you encounter a bug or have a suggestion for improvement, please open an issue on Incremental Social. Provide as much detail as possible, including an example repo or steps to reproduce the issue if applicable.
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
By contributing to Profectus, you agree that your contributions will be licensed under the project's [LICENSE](./LICENSE).
|