We have adopted a Code of Conduct, that we expect all the participants of our project to adhere to. You can find the full text here.
Development of the project is done publicly on GitHub. Core team members and also other external contributors send Pull Requests and they all go through the same review process.
Bugs can be reported as GitHub Issues.
Before submitting any issue, please make sure they are not a duplicate of any other existing issues.
For every new feature, package or a change, we post proposals under GitHub Issues publicly.
Members from the project and other interested parties can then comment on the proposal, discussing about the strengths and weaknesses, and the proposal gets refined/updated based on feedback.
Once the spec is ready and finalized, the development begins.
In your Proposal description, make sure you answer these questions:
If you are looking for ways to contribute with code or documentation to the project directly, you can help us out by contributing to issues with
help wanted label on GitHub.
We already have automated checks for tests and linting for all Pull Requests, but you can always run these commands locally to make sure everything is working as expected:
$ npm install $ npm run bootstrap $ npm run lint $ npm test
If your Pull Request results in a change in the API, then please update the examples in the same repository accordingly, as well as the API documentation (
README.md of every package).
By contributing to ProppyJS, you agree that your contributions will be licensed under its MIT license.