[Notes] [Git][BuildStream/buildstream][master] 4 commits: Add a section on how to raise an issue

[Tristan Van Berkom <gitlab mg gitlab com>]

Title: GitLab

Tristan Van Berkom pushed to branch master at BuildStream / buildstream

Commits:

• 8db62230
  by Adam Jones at 2018-09-17T07:39:06Z

  Add a section on how to raise an issue
  

• 6f0a3e98
  by Adam Jones at 2018-09-17T07:39:20Z

  Rename HACKING.rst to CONTRIBUTING.rst
  

• ade19151
  by Adam Jones at 2018-09-17T07:40:45Z

  update HACKING references
  

• b9c5ff7d
  by Tristan Van Berkom at 2018-09-17T08:09:12Z

  Merge branch 'tristan/contributing-guide' into 'master'
  
  Update contributing guide
  
  See merge request BuildStream/buildstream!801

6 changed files:

• HACKING.rst → CONTRIBUTING.rst
• MANIFEST.in
• doc/bst2html.py
• + doc/source/CONTRIBUTING.rst
• − doc/source/HACKING.rst
• doc/source/index.rst

Changes:

HACKING.rst → CONTRIBUTING.rst

---

...	...	@@ -10,6 +10,12 @@ Major feature additions should be proposed on the
10	10	before being considered for inclusion, we strongly recommend proposing
11	11	in advance of commencing work.
12	12
	13	+If you are experiencing an issue with BuildStream or would like to submit a small patch/feature, then
	14	+you can open issue `here <https://gitlab.com/BuildStream/buildstream/issues/new?issue%5Bassignee_id%5D=&issue%5Bmilestone_id%5D=>`
	15	+
	16	+For policies on how to submit and issue and how to use our project labels, we recommend that you read the policies guide
	17	+`here <https://gitlab.com/BuildStream/nosoftware/alignment/blob/master/BuildStream_policies.md>`
	18	+
13	19	New features must be well documented and tested either in our main
14	20	test suite if possible, or otherwise in the integration tests.
15	21

MANIFEST.in

---

1	1	# Basic toplevel package includes
2	2	include BuildStream.doap
3	3	include COPYING
4		-include HACKING.rst
	4	+include CONTRIBUTING.rst
5	5	include MAINTAINERS
6	6	include NEWS
7	7	include README.rst

doc/bst2html.py

---

...	...	@@ -444,7 +444,7 @@ def run_session(description, tempdir, source_cache, palette, config_file, force)
444	444	def run_bst(directory, force, source_cache, description, palette):
445	445	"""Run a bst command and capture stdout/stderr in html
446	446
447		- This command normally takes a description yaml file, see the HACKING
	447	+ This command normally takes a description yaml file, see the CONTRIBUTING
448	448	file for information on it's format.
449	449	"""
450	450	if not source_cache and os.environ.get('BST_SOURCE_CACHE'):

doc/source/CONTRIBUTING.rst

---

	1	+../../CONTRIBUTING.rst
		\ No newline at end of file

doc/source/HACKING.rst deleted

---

1		-../../HACKING.rst
		\ No newline at end of file

doc/source/index.rst

---

...	...	@@ -21,7 +21,7 @@ Later sections provide detailed information on BuildStream internals.
21	21	main_install
22	22	main_using
23	23	main_core
24		- HACKING
	24	+ CONTRIBUTING
25	25
26	26
27	27	Resources

—
View it on GitLab.
You're receiving this email because of your account on gitlab.com. If you'd like to receive fewer emails, you can adjust your notification settings.