Skip to content

Latest commit

 

History

History
32 lines (23 loc) · 2.09 KB

CONTRIBUTING.md

File metadata and controls

32 lines (23 loc) · 2.09 KB

Contributing to Noe Core

Thank you for considering contribution to Noe Core. As a potential contributor, your changes and ideas are always welcome. Please do not ever hesitate to ask a question or send a Pull Request.

How Can I Contribute?

Reporting Bugs

If you come across what seems to be a bug, please use the Github issue tracker and file an issue. An issue can also be used for discussions.

Contributing Documentation

Documentation is crucial for success of any project. If you feel like there is lack of documentation in some area, feel free to file an issue. If you want to contribute documentation, feel free to open a PR with your changes. Your contribution may or may not be changed with stylistic and grammatical corrections; do not expect to see your changes ad verbum in the code.

Contributing Code

To limit wasted effort and time, before contributing code, please open up an issue where you describe your desired change in Noe Core. After a debate and review of the idea, follow the Contribution Workflow section to get your patch accepted.

Contribution Workflow

Noe Core uses the standard Github's Pull Request workflow. In addition, we expect you to:

  1. Adhere to the review provided within the pull request. If you disagree, we are always open to a debate.
  2. Adhere to the Apache software Foundation's Code of Conduct.
  3. Provide integration and unit test where applicable.
  4. Provide full documentation for your changes where applicable.
  5. Provide reasonable commit messages.
  6. Adhere to our codestyle.

We use the same coding style as Wildfly with the following exceptions:

  • Indentation size is 2 spaces.
  • Contined indentation is 4 spaces.
  • Maximum line length is 160 chars.

Missing Something?

Are you missing something? Is something confusing? Is something unreasonable? Please let us know!