Skip to content

Latest commit

 

History

History
33 lines (23 loc) · 1.71 KB

CONTRIBUTING.md

File metadata and controls

33 lines (23 loc) · 1.71 KB

Contributing

We welcome and appreciate your contributions to beCPG PLM! Whether it's code, translations, or suggestions, your help is essential for the project's success. Please follow the guidelines below to contribute effectively.

Getting Started

  1. Review our Contributor Code of Conduct. By participating in this project, you agree to abide by its terms.
  2. If you have suggestions, bug reports, or want to discuss improvements, open an issue. We value all contributions and would love to hear from you.

Submitting a Pull Request

  1. [Fork](/fork) and clone the repository.
  2. Configure and install dependencies: ./run.sh build_start.
  3. Ensure tests pass on your machine: ./run.sh test.
  4. Create a new branch: git checkout -b my-branch-name.
  5. Make your changes, add tests, and ensure the tests still pass.
  6. Push to your fork and submit a pull request.
  7. Celebrate! Wait for your pull request to be reviewed and merged.

To increase the likelihood of your pull request being accepted:

  • Follow our style guide.
  • Write and update tests to cover your changes.
  • Keep changes focused. Consider submitting unrelated changes as separate pull requests.
  • Write a good commit message.

Feel free to submit Work in Progress pull requests to get early feedback or if you encounter any blockers.

Additional Resources